diff --git a/pkg/gen/ghcapi/embedded_spec.go b/pkg/gen/ghcapi/embedded_spec.go
index 99884cc6b57..d84b59fe148 100644
--- a/pkg/gen/ghcapi/embedded_spec.go
+++ b/pkg/gen/ghcapi/embedded_spec.go
@@ -1516,7 +1516,7 @@ func init() {
},
"/move-task-orders/{moveTaskOrderID}/status": {
"patch": {
- "description": "Changes move task order status",
+ "description": "Changes move task order status to make it available to prime",
"consumes": [
"application/json"
],
@@ -1526,7 +1526,7 @@ func init() {
"tags": [
"moveTaskOrder"
],
- "summary": "Change the status of a move task order",
+ "summary": "Change the status of a move task order to make it available to prime",
"operationId": "updateMoveTaskOrderStatus",
"parameters": [
{
@@ -7148,6 +7148,12 @@ func init() {
"type": "integer",
"x-nullable": true,
"example": 500
+ },
+ "weightRestriction": {
+ "description": "Indicates the weight restriction for a move to a particular location.",
+ "type": "integer",
+ "x-nullable": true,
+ "example": 1500
}
}
},
@@ -8355,6 +8361,12 @@ func init() {
"type": "integer",
"x-nullable": true,
"example": 3
+ },
+ "weightRestriction": {
+ "type": "integer",
+ "x-formatting": "weight",
+ "x-nullable": true,
+ "example": 1500
}
}
},
@@ -14242,6 +14254,12 @@ func init() {
"type": "integer",
"x-nullable": true,
"example": 500
+ },
+ "weightRestriction": {
+ "description": "Indicates the weight restriction for the move to a particular location.",
+ "type": "integer",
+ "x-nullable": true,
+ "example": 1500
}
}
},
@@ -24327,6 +24345,12 @@ func init() {
"type": "integer",
"x-nullable": true,
"example": 500
+ },
+ "weightRestriction": {
+ "description": "Indicates the weight restriction for a move to a particular location.",
+ "type": "integer",
+ "x-nullable": true,
+ "example": 1500
}
}
},
@@ -25534,6 +25558,12 @@ func init() {
"type": "integer",
"x-nullable": true,
"example": 3
+ },
+ "weightRestriction": {
+ "type": "integer",
+ "x-formatting": "weight",
+ "x-nullable": true,
+ "example": 1500
}
}
},
@@ -31553,6 +31583,12 @@ func init() {
"type": "integer",
"x-nullable": true,
"example": 500
+ },
+ "weightRestriction": {
+ "description": "Indicates the weight restriction for the move to a particular location.",
+ "type": "integer",
+ "x-nullable": true,
+ "example": 1500
}
}
},
diff --git a/pkg/gen/ghcmessages/counseling_update_allowance_payload.go b/pkg/gen/ghcmessages/counseling_update_allowance_payload.go
index d6bed9fac0c..805a206b000 100644
--- a/pkg/gen/ghcmessages/counseling_update_allowance_payload.go
+++ b/pkg/gen/ghcmessages/counseling_update_allowance_payload.go
@@ -70,6 +70,10 @@ type CounselingUpdateAllowancePayload struct {
// ub allowance
// Example: 500
UbAllowance *int64 `json:"ubAllowance,omitempty"`
+
+ // Indicates the weight restriction for a move to a particular location.
+ // Example: 1500
+ WeightRestriction *int64 `json:"weightRestriction,omitempty"`
}
// Validate validates this counseling update allowance payload
diff --git a/pkg/gen/ghcmessages/entitlements.go b/pkg/gen/ghcmessages/entitlements.go
index 2ee15f3d03a..e856534cc33 100644
--- a/pkg/gen/ghcmessages/entitlements.go
+++ b/pkg/gen/ghcmessages/entitlements.go
@@ -90,6 +90,10 @@ type Entitlements struct {
// The amount of weight in pounds that the move is entitled for shipment types of Unaccompanied Baggage.
// Example: 3
UnaccompaniedBaggageAllowance *int64 `json:"unaccompaniedBaggageAllowance,omitempty"`
+
+ // weight restriction
+ // Example: 1500
+ WeightRestriction *int64 `json:"weightRestriction,omitempty"`
}
// Validate validates this entitlements
diff --git a/pkg/gen/ghcmessages/update_allowance_payload.go b/pkg/gen/ghcmessages/update_allowance_payload.go
index ee0d677c0e7..c0aa957934a 100644
--- a/pkg/gen/ghcmessages/update_allowance_payload.go
+++ b/pkg/gen/ghcmessages/update_allowance_payload.go
@@ -70,6 +70,10 @@ type UpdateAllowancePayload struct {
// ub allowance
// Example: 500
UbAllowance *int64 `json:"ubAllowance,omitempty"`
+
+ // Indicates the weight restriction for the move to a particular location.
+ // Example: 1500
+ WeightRestriction *int64 `json:"weightRestriction,omitempty"`
}
// Validate validates this update allowance payload
diff --git a/pkg/gen/primeapi/embedded_spec.go b/pkg/gen/primeapi/embedded_spec.go
index ab7b9225ce4..c4dfc4fb5b2 100644
--- a/pkg/gen/primeapi/embedded_spec.go
+++ b/pkg/gen/primeapi/embedded_spec.go
@@ -1828,6 +1828,12 @@ func init() {
"type": "integer",
"x-nullable": true,
"example": 3
+ },
+ "weightRestriction": {
+ "type": "integer",
+ "x-formatting": "weight",
+ "x-nullable": true,
+ "example": 1500
}
}
},
@@ -6899,6 +6905,12 @@ func init() {
"type": "integer",
"x-nullable": true,
"example": 3
+ },
+ "weightRestriction": {
+ "type": "integer",
+ "x-formatting": "weight",
+ "x-nullable": true,
+ "example": 1500
}
}
},
diff --git a/pkg/gen/primemessages/entitlements.go b/pkg/gen/primemessages/entitlements.go
index c51ada24273..65870bfa8e6 100644
--- a/pkg/gen/primemessages/entitlements.go
+++ b/pkg/gen/primemessages/entitlements.go
@@ -79,6 +79,10 @@ type Entitlements struct {
// The amount of weight in pounds that the move is entitled for shipment types of Unaccompanied Baggage.
// Example: 3
UnaccompaniedBaggageAllowance *int64 `json:"unaccompaniedBaggageAllowance,omitempty"`
+
+ // weight restriction
+ // Example: 1500
+ WeightRestriction *int64 `json:"weightRestriction,omitempty"`
}
// Validate validates this entitlements
diff --git a/pkg/gen/primev2api/embedded_spec.go b/pkg/gen/primev2api/embedded_spec.go
index 8cbeaf84b17..9e0f66eb6c8 100644
--- a/pkg/gen/primev2api/embedded_spec.go
+++ b/pkg/gen/primev2api/embedded_spec.go
@@ -1064,6 +1064,12 @@ func init() {
"type": "integer",
"x-nullable": true,
"example": 3
+ },
+ "weightRestriction": {
+ "type": "integer",
+ "x-formatting": "weight",
+ "x-nullable": true,
+ "example": 1500
}
}
},
@@ -4822,6 +4828,12 @@ func init() {
"type": "integer",
"x-nullable": true,
"example": 3
+ },
+ "weightRestriction": {
+ "type": "integer",
+ "x-formatting": "weight",
+ "x-nullable": true,
+ "example": 1500
}
}
},
diff --git a/pkg/gen/primev2messages/entitlements.go b/pkg/gen/primev2messages/entitlements.go
index e29d3f733e3..58280696ab1 100644
--- a/pkg/gen/primev2messages/entitlements.go
+++ b/pkg/gen/primev2messages/entitlements.go
@@ -79,6 +79,10 @@ type Entitlements struct {
// The amount of weight in pounds that the move is entitled for shipment types of Unaccompanied Baggage.
// Example: 3
UnaccompaniedBaggageAllowance *int64 `json:"unaccompaniedBaggageAllowance,omitempty"`
+
+ // weight restriction
+ // Example: 1500
+ WeightRestriction *int64 `json:"weightRestriction,omitempty"`
}
// Validate validates this entitlements
diff --git a/pkg/gen/primev3api/embedded_spec.go b/pkg/gen/primev3api/embedded_spec.go
index b936756cd78..e5bde117279 100644
--- a/pkg/gen/primev3api/embedded_spec.go
+++ b/pkg/gen/primev3api/embedded_spec.go
@@ -1226,6 +1226,12 @@ func init() {
"type": "integer",
"x-nullable": true,
"example": 3
+ },
+ "weightRestriction": {
+ "type": "integer",
+ "x-formatting": "weight",
+ "x-nullable": true,
+ "example": 1500
}
}
},
@@ -5694,6 +5700,12 @@ func init() {
"type": "integer",
"x-nullable": true,
"example": 3
+ },
+ "weightRestriction": {
+ "type": "integer",
+ "x-formatting": "weight",
+ "x-nullable": true,
+ "example": 1500
}
}
},
diff --git a/pkg/gen/primev3messages/entitlements.go b/pkg/gen/primev3messages/entitlements.go
index 1e228c6350f..2ef73ccfbf5 100644
--- a/pkg/gen/primev3messages/entitlements.go
+++ b/pkg/gen/primev3messages/entitlements.go
@@ -79,6 +79,10 @@ type Entitlements struct {
// The amount of weight in pounds that the move is entitled for shipment types of Unaccompanied Baggage.
// Example: 3
UnaccompaniedBaggageAllowance *int64 `json:"unaccompaniedBaggageAllowance,omitempty"`
+
+ // weight restriction
+ // Example: 1500
+ WeightRestriction *int64 `json:"weightRestriction,omitempty"`
}
// Validate validates this entitlements
diff --git a/pkg/gen/supportapi/embedded_spec.go b/pkg/gen/supportapi/embedded_spec.go
index a8fc82230f8..b794a05a20e 100644
--- a/pkg/gen/supportapi/embedded_spec.go
+++ b/pkg/gen/supportapi/embedded_spec.go
@@ -1183,6 +1183,11 @@ func init() {
"type": "integer",
"x-nullable": true,
"example": 3
+ },
+ "weightRestriction": {
+ "type": "integer",
+ "x-nullable": true,
+ "example": 1500
}
}
},
@@ -4051,6 +4056,11 @@ func init() {
"type": "integer",
"x-nullable": true,
"example": 3
+ },
+ "weightRestriction": {
+ "type": "integer",
+ "x-nullable": true,
+ "example": 1500
}
}
},
diff --git a/pkg/gen/supportmessages/entitlement.go b/pkg/gen/supportmessages/entitlement.go
index 434ad8aeed3..f1fd0f5f8c9 100644
--- a/pkg/gen/supportmessages/entitlement.go
+++ b/pkg/gen/supportmessages/entitlement.go
@@ -81,6 +81,10 @@ type Entitlement struct {
// The amount of weight in pounds that the move is entitled for shipment types of Unaccompanied Baggage.
// Example: 3
UnaccompaniedBaggageAllowance *int64 `json:"unaccompaniedBaggageAllowance,omitempty"`
+
+ // weight restriction
+ // Example: 1500
+ WeightRestriction *int64 `json:"weightRestriction,omitempty"`
}
// Validate validates this entitlement
diff --git a/pkg/handlers/ghcapi/internal/payloads/model_to_payload.go b/pkg/handlers/ghcapi/internal/payloads/model_to_payload.go
index 0e7b12109e8..4683878b07f 100644
--- a/pkg/handlers/ghcapi/internal/payloads/model_to_payload.go
+++ b/pkg/handlers/ghcapi/internal/payloads/model_to_payload.go
@@ -733,6 +733,11 @@ func Entitlement(entitlement *models.Entitlement) *ghcmessages.Entitlements {
if entitlement.UBAllowance != nil {
ubAllowance = models.Int64Pointer(int64(*entitlement.UBAllowance))
}
+ var weightRestriction *int64
+ if entitlement.WeightRestriction != nil {
+ weightRestriction = models.Int64Pointer(int64(*entitlement.WeightRestriction))
+ }
+
return &ghcmessages.Entitlements{
ID: strfmt.UUID(entitlement.ID.String()),
AuthorizedWeight: authorizedWeight,
@@ -750,8 +755,9 @@ func Entitlement(entitlement *models.Entitlement) *ghcmessages.Entitlements {
AccompaniedTour: accompaniedTour,
UnaccompaniedBaggageAllowance: ubAllowance,
OrganizationalClothingAndIndividualEquipment: entitlement.OrganizationalClothingAndIndividualEquipment,
- GunSafe: gunSafe,
- ETag: etag.GenerateEtag(entitlement.UpdatedAt),
+ GunSafe: gunSafe,
+ WeightRestriction: weightRestriction,
+ ETag: etag.GenerateEtag(entitlement.UpdatedAt),
}
}
diff --git a/pkg/handlers/ghcapi/internal/payloads/model_to_payload_test.go b/pkg/handlers/ghcapi/internal/payloads/model_to_payload_test.go
index 7a4edc2d84d..51be3548bc0 100644
--- a/pkg/handlers/ghcapi/internal/payloads/model_to_payload_test.go
+++ b/pkg/handlers/ghcapi/internal/payloads/model_to_payload_test.go
@@ -667,6 +667,7 @@ func (suite *PayloadsSuite) TestEntitlement() {
dependentsTwelveAndOver := 1
authorizedWeight := 8000
ubAllowance := 300
+ weightRestriction := 1000
entitlement := &models.Entitlement{
ID: entitlementID,
@@ -684,6 +685,7 @@ func (suite *PayloadsSuite) TestEntitlement() {
DependentsTwelveAndOver: &dependentsTwelveAndOver,
UpdatedAt: time.Now(),
UBAllowance: &ubAllowance,
+ WeightRestriction: &weightRestriction,
}
returnedEntitlement := Entitlement(entitlement)
@@ -705,6 +707,7 @@ func (suite *PayloadsSuite) TestEntitlement() {
suite.Equal(models.BoolPointer(accompaniedTour), returnedEntitlement.AccompaniedTour)
suite.Equal(dependentsUnderTwelve, int(*returnedEntitlement.DependentsUnderTwelve))
suite.Equal(dependentsTwelveAndOver, int(*returnedEntitlement.DependentsTwelveAndOver))
+ suite.Equal(weightRestriction, int(*returnedEntitlement.WeightRestriction))
}
func (suite *PayloadsSuite) TestCreateCustomer() {
diff --git a/pkg/handlers/ghcapi/orders.go b/pkg/handlers/ghcapi/orders.go
index 51fec571935..50af15473e9 100644
--- a/pkg/handlers/ghcapi/orders.go
+++ b/pkg/handlers/ghcapi/orders.go
@@ -290,6 +290,8 @@ func (h CreateOrderHandler) Handle(params orderop.CreateOrderParams) middleware.
weightAllotment.UnaccompaniedBaggageAllowance = unaccompaniedBaggageAllowance
}
+ var weightRestriction *int
+
entitlement := models.Entitlement{
DependentsAuthorized: payload.HasDependents,
DBAuthorizedWeight: models.IntPointer(weight),
@@ -300,6 +302,7 @@ func (h CreateOrderHandler) Handle(params orderop.CreateOrderParams) middleware.
DependentsUnderTwelve: dependentsUnderTwelve,
DependentsTwelveAndOver: dependentsTwelveAndOver,
UBAllowance: &weightAllotment.UnaccompaniedBaggageAllowance,
+ WeightRestriction: weightRestriction,
}
if saveEntitlementErr := appCtx.DB().Save(&entitlement); saveEntitlementErr != nil {
diff --git a/pkg/handlers/primeapi/payloads/model_to_payload.go b/pkg/handlers/primeapi/payloads/model_to_payload.go
index af39f03827f..3c8a3f1b292 100644
--- a/pkg/handlers/primeapi/payloads/model_to_payload.go
+++ b/pkg/handlers/primeapi/payloads/model_to_payload.go
@@ -262,6 +262,10 @@ func Entitlement(entitlement *models.Entitlement) *primemessages.Entitlements {
if entitlement.UBAllowance != nil {
ubAllowance = int64(*entitlement.UBAllowance)
}
+ var weightRestriction int64
+ if entitlement.WeightRestriction != nil {
+ weightRestriction = int64(*entitlement.WeightRestriction)
+ }
return &primemessages.Entitlements{
ID: strfmt.UUID(entitlement.ID.String()),
AuthorizedWeight: authorizedWeight,
@@ -274,10 +278,11 @@ func Entitlement(entitlement *models.Entitlement) *primemessages.Entitlements {
ProGearWeightSpouse: int64(entitlement.ProGearWeightSpouse),
RequiredMedicalEquipmentWeight: int64(entitlement.RequiredMedicalEquipmentWeight),
OrganizationalClothingAndIndividualEquipment: entitlement.OrganizationalClothingAndIndividualEquipment,
- StorageInTransit: sit,
- TotalDependents: totalDependents,
- TotalWeight: totalWeight,
- ETag: etag.GenerateEtag(entitlement.UpdatedAt),
+ StorageInTransit: sit,
+ TotalDependents: totalDependents,
+ TotalWeight: totalWeight,
+ WeightRestriction: &weightRestriction,
+ ETag: etag.GenerateEtag(entitlement.UpdatedAt),
}
}
diff --git a/pkg/handlers/primeapi/payloads/model_to_payload_test.go b/pkg/handlers/primeapi/payloads/model_to_payload_test.go
index 44cf2c2e40d..f070c4342d2 100644
--- a/pkg/handlers/primeapi/payloads/model_to_payload_test.go
+++ b/pkg/handlers/primeapi/payloads/model_to_payload_test.go
@@ -351,6 +351,7 @@ func (suite *PayloadsSuite) TestEntitlement() {
ProGearWeightSpouse: 750,
CreatedAt: time.Now(),
UpdatedAt: time.Now(),
+ WeightRestriction: models.IntPointer(1000),
}
// TotalWeight needs to read from the internal weightAllotment, in this case 7000 lbs w/o dependents and
@@ -373,6 +374,7 @@ func (suite *PayloadsSuite) TestEntitlement() {
suite.Equal(true, payload.OrganizationalClothingAndIndividualEquipment)
suite.Equal(int64(1000), payload.ProGearWeight)
suite.Equal(int64(750), payload.ProGearWeightSpouse)
+ suite.Equal(int64(1000), *payload.WeightRestriction)
suite.NotEmpty(payload.ETag)
suite.Equal(etag.GenerateEtag(entitlement.UpdatedAt), payload.ETag)
})
diff --git a/pkg/handlers/primeapiv2/payloads/model_to_payload.go b/pkg/handlers/primeapiv2/payloads/model_to_payload.go
index 3a49ba8b5fb..106a3bd5cf3 100644
--- a/pkg/handlers/primeapiv2/payloads/model_to_payload.go
+++ b/pkg/handlers/primeapiv2/payloads/model_to_payload.go
@@ -191,6 +191,10 @@ func Entitlement(entitlement *models.Entitlement) *primev2messages.Entitlements
if entitlement.UBAllowance != nil {
ubAllowance = int64(*entitlement.UBAllowance)
}
+ var weightRestriction int64
+ if entitlement.WeightRestriction != nil {
+ weightRestriction = int64(*entitlement.WeightRestriction)
+ }
return &primev2messages.Entitlements{
ID: strfmt.UUID(entitlement.ID.String()),
AuthorizedWeight: authorizedWeight,
@@ -203,10 +207,11 @@ func Entitlement(entitlement *models.Entitlement) *primev2messages.Entitlements
ProGearWeightSpouse: int64(entitlement.ProGearWeightSpouse),
RequiredMedicalEquipmentWeight: int64(entitlement.RequiredMedicalEquipmentWeight),
OrganizationalClothingAndIndividualEquipment: entitlement.OrganizationalClothingAndIndividualEquipment,
- StorageInTransit: sit,
- TotalDependents: totalDependents,
- TotalWeight: totalWeight,
- ETag: etag.GenerateEtag(entitlement.UpdatedAt),
+ StorageInTransit: sit,
+ TotalDependents: totalDependents,
+ TotalWeight: totalWeight,
+ WeightRestriction: &weightRestriction,
+ ETag: etag.GenerateEtag(entitlement.UpdatedAt),
}
}
diff --git a/pkg/handlers/primeapiv2/payloads/model_to_payload_test.go b/pkg/handlers/primeapiv2/payloads/model_to_payload_test.go
index cb69d490a44..7b68e2a8e69 100644
--- a/pkg/handlers/primeapiv2/payloads/model_to_payload_test.go
+++ b/pkg/handlers/primeapiv2/payloads/model_to_payload_test.go
@@ -303,6 +303,7 @@ func (suite *PayloadsSuite) TestEntitlement() {
ProGearWeightSpouse: 0,
CreatedAt: time.Now(),
UpdatedAt: time.Now(),
+ WeightRestriction: models.IntPointer(1000),
}
payload := Entitlement(&entitlement)
@@ -325,6 +326,7 @@ func (suite *PayloadsSuite) TestEntitlement() {
suite.Equal(int64(0), payload.TotalDependents)
suite.Equal(int64(0), payload.TotalWeight)
suite.Equal(int64(0), *payload.UnaccompaniedBaggageAllowance)
+ suite.Equal(int64(1000), *payload.WeightRestriction)
})
suite.Run("Success - Returns the entitlement payload with all optional fields populated", func() {
diff --git a/pkg/handlers/primeapiv3/payloads/model_to_payload.go b/pkg/handlers/primeapiv3/payloads/model_to_payload.go
index 7393e60cf56..14d408b55fb 100644
--- a/pkg/handlers/primeapiv3/payloads/model_to_payload.go
+++ b/pkg/handlers/primeapiv3/payloads/model_to_payload.go
@@ -219,6 +219,10 @@ func Entitlement(entitlement *models.Entitlement) *primev3messages.Entitlements
if entitlement.UBAllowance != nil {
ubAllowance = int64(*entitlement.UBAllowance)
}
+ var weightRestriction int64
+ if entitlement.WeightRestriction != nil {
+ weightRestriction = int64(*entitlement.WeightRestriction)
+ }
return &primev3messages.Entitlements{
ID: strfmt.UUID(entitlement.ID.String()),
AuthorizedWeight: authorizedWeight,
@@ -230,10 +234,11 @@ func Entitlement(entitlement *models.Entitlement) *primev3messages.Entitlements
ProGearWeightSpouse: int64(entitlement.ProGearWeightSpouse),
RequiredMedicalEquipmentWeight: int64(entitlement.RequiredMedicalEquipmentWeight),
OrganizationalClothingAndIndividualEquipment: entitlement.OrganizationalClothingAndIndividualEquipment,
- StorageInTransit: sit,
- TotalDependents: totalDependents,
- TotalWeight: totalWeight,
- ETag: etag.GenerateEtag(entitlement.UpdatedAt),
+ StorageInTransit: sit,
+ TotalDependents: totalDependents,
+ TotalWeight: totalWeight,
+ WeightRestriction: &weightRestriction,
+ ETag: etag.GenerateEtag(entitlement.UpdatedAt),
}
}
diff --git a/pkg/handlers/primeapiv3/payloads/model_to_payload_test.go b/pkg/handlers/primeapiv3/payloads/model_to_payload_test.go
index 3ff9bf25b94..475008105bb 100644
--- a/pkg/handlers/primeapiv3/payloads/model_to_payload_test.go
+++ b/pkg/handlers/primeapiv3/payloads/model_to_payload_test.go
@@ -545,6 +545,7 @@ func (suite *PayloadsSuite) TestEntitlement() {
ProGearWeightSpouse: 0,
CreatedAt: time.Now(),
UpdatedAt: time.Now(),
+ WeightRestriction: models.IntPointer(1000),
}
payload := Entitlement(&entitlement)
@@ -567,6 +568,7 @@ func (suite *PayloadsSuite) TestEntitlement() {
suite.Equal(int64(0), payload.TotalDependents)
suite.Equal(int64(0), payload.TotalWeight)
suite.Equal(int64(0), *payload.UnaccompaniedBaggageAllowance)
+ suite.Equal(int64(1000), *payload.WeightRestriction)
})
suite.Run("Success - Returns the entitlement payload with all optional fields populated", func() {
diff --git a/pkg/services/order/order_updater.go b/pkg/services/order/order_updater.go
index e08896380c3..f2efe7f2a57 100644
--- a/pkg/services/order/order_updater.go
+++ b/pkg/services/order/order_updater.go
@@ -485,6 +485,11 @@ func allowanceFromTOOPayload(appCtx appcontext.AppContext, existingOrder models.
order.Entitlement.GunSafe = *payload.GunSafe
}
+ if payload.WeightRestriction != nil {
+ weightRestriction := int(*payload.WeightRestriction)
+ order.Entitlement.WeightRestriction = &weightRestriction
+ }
+
if payload.AccompaniedTour != nil {
order.Entitlement.AccompaniedTour = payload.AccompaniedTour
}
@@ -531,7 +536,6 @@ func allowanceFromTOOPayload(appCtx appcontext.AppContext, existingOrder models.
return order, nil
}
-
func allowanceFromCounselingPayload(appCtx appcontext.AppContext, existingOrder models.Order, payload ghcmessages.CounselingUpdateAllowancePayload) (models.Order, error) {
order := existingOrder
waf := entitlements.NewWeightAllotmentFetcher()
@@ -589,6 +593,11 @@ func allowanceFromCounselingPayload(appCtx appcontext.AppContext, existingOrder
order.Entitlement.GunSafe = *payload.GunSafe
}
+ if payload.WeightRestriction != nil {
+ weightRestriction := int(*payload.WeightRestriction)
+ order.Entitlement.WeightRestriction = &weightRestriction
+ }
+
if payload.AccompaniedTour != nil {
order.Entitlement.AccompaniedTour = payload.AccompaniedTour
}
diff --git a/pkg/services/order/order_updater_test.go b/pkg/services/order/order_updater_test.go
index 1bf72866552..0fa72e8d904 100644
--- a/pkg/services/order/order_updater_test.go
+++ b/pkg/services/order/order_updater_test.go
@@ -775,6 +775,7 @@ func (suite *OrderServiceSuite) TestUpdateAllowanceAsCounselor() {
proGearWeightSpouse := models.Int64Pointer(10)
rmeWeight := models.Int64Pointer(10000)
eTag := etag.GenerateEtag(order.UpdatedAt)
+ weightRestriction := models.Int64Pointer(5000)
payload := ghcmessages.CounselingUpdateAllowancePayload{
Agency: &affiliation,
@@ -784,6 +785,7 @@ func (suite *OrderServiceSuite) TestUpdateAllowanceAsCounselor() {
ProGearWeight: proGearWeight,
ProGearWeightSpouse: proGearWeightSpouse,
RequiredMedicalEquipmentWeight: rmeWeight,
+ WeightRestriction: weightRestriction,
}
updatedOrder, _, err := orderUpdater.UpdateAllowanceAsCounselor(suite.AppContextForTest(), order.ID, payload, eTag)
@@ -804,6 +806,7 @@ func (suite *OrderServiceSuite) TestUpdateAllowanceAsCounselor() {
suite.Equal(*payload.OrganizationalClothingAndIndividualEquipment, updatedOrder.Entitlement.OrganizationalClothingAndIndividualEquipment)
suite.EqualValues(payload.Agency, fetchedSM.Affiliation)
suite.Equal(*updatedOrder.Entitlement.DBAuthorizedWeight, 16000)
+ suite.Equal(*payload.WeightRestriction, int64(*updatedOrder.Entitlement.WeightRestriction))
})
suite.Run("Updates the allowance when all fields are valid with dependents present and authorized", func() {
diff --git a/src/components/Office/AllowancesDetailForm/AllowancesDetailForm.jsx b/src/components/Office/AllowancesDetailForm/AllowancesDetailForm.jsx
index 94d8bcc2dc3..b37e779d046 100644
--- a/src/components/Office/AllowancesDetailForm/AllowancesDetailForm.jsx
+++ b/src/components/Office/AllowancesDetailForm/AllowancesDetailForm.jsx
@@ -1,5 +1,6 @@
import React, { useState, useEffect } from 'react';
import PropTypes from 'prop-types';
+import { useFormikContext } from 'formik';
import { isBooleanFlagEnabled } from '../../../utils/featureFlags';
import { FEATURE_FLAG_KEYS } from '../../../shared/constants';
@@ -20,6 +21,8 @@ const AllowancesDetailForm = ({ header, entitlements, branchOptions, formIsDisab
entitlements?.dependentsTwelveAndOver ||
entitlements?.dependentsUnderTwelve
);
+ const { setFieldValue } = useFormikContext();
+ const [isAdminWeightLocationChecked, setIsAdminWeightLocationChecked] = useState(entitlements?.weightRestriction > 0);
useEffect(() => {
// Functional component version of "componentDidMount"
// By leaving the dependency array empty this will only run once
@@ -32,6 +35,25 @@ const AllowancesDetailForm = ({ header, entitlements, branchOptions, formIsDisab
checkUBFeatureFlag();
}, []);
+ useEffect(() => {
+ if (!isAdminWeightLocationChecked) {
+ // Find the weight restriction input and reset its value to 0
+ const weightRestrictionInput = document.getElementById('weightRestrictionId');
+ if (weightRestrictionInput) {
+ weightRestrictionInput.value = '';
+ }
+ }
+ }, [isAdminWeightLocationChecked]);
+
+ const handleAdminWeightLocationChange = (e) => {
+ const isChecked = e.target.checked;
+ setIsAdminWeightLocationChecked(isChecked);
+
+ if (!isChecked) {
+ setFieldValue('weightRestriction', '');
+ }
+ };
+
return (
{header &&
{header}
}
@@ -146,6 +168,10 @@ const AllowancesDetailForm = ({ header, entitlements, branchOptions, formIsDisab
lazy={false} // immediate masking evaluation
isDisabled={formIsDisabled}
/>
+
+ - Standard weight allowance
+ - {formatWeight(entitlements.totalWeight)}
+
-
- - Weight allowance
- - {formatWeight(entitlements.totalWeight)}
-
+
+
+
+ {isAdminWeightLocationChecked && (
+
+ )}
{
expect(screen.queryByLabelText(/Number of dependents of the age 12 or over/)).toBeInTheDocument();
});
});
+describe('AllowancesDetailForm additional tests', () => {
+ it('renders gun safe checkbox field', async () => {
+ render(
+
+
+ ,
+ );
+
+ expect(await screen.findByTestId('gunSafeInput')).toBeInTheDocument();
+ });
+
+ it('renders admin weight location section with conditional weight restriction field', async () => {
+ render(
+
+
+ ,
+ );
+
+ const adminWeightCheckbox = await screen.findByTestId('adminWeightLocation');
+ expect(adminWeightCheckbox).toBeInTheDocument();
+ expect(screen.queryByTestId('weightRestrictionInput')).not.toBeInTheDocument();
+ await act(async () => {
+ adminWeightCheckbox.click();
+ });
+ expect(screen.getByTestId('weightRestrictionInput')).toBeInTheDocument();
+ });
+
+ it('displays the total weight allowance correctly', async () => {
+ render(
+
+
+ ,
+ );
+
+ expect(await screen.findByTestId('weightAllowance')).toHaveTextContent('11,000');
+ });
+});
diff --git a/src/components/Office/DefinitionLists/AllowancesList.jsx b/src/components/Office/DefinitionLists/AllowancesList.jsx
index 3d5c1e850cc..7bdd17862ae 100644
--- a/src/components/Office/DefinitionLists/AllowancesList.jsx
+++ b/src/components/Office/DefinitionLists/AllowancesList.jsx
@@ -16,7 +16,6 @@ const AllowancesList = ({ info, showVisualCues }) => {
const visualCuesStyle = classNames(descriptionListStyles.row, {
[`${descriptionListStyles.rowWithVisualCue}`]: showVisualCues,
});
-
useEffect(() => {
const checkUBFeatureFlag = async () => {
const enabled = await isBooleanFlagEnabled(FEATURE_FLAG_KEYS.UNACCOMPANIED_BAGGAGE);
@@ -35,7 +34,7 @@ const AllowancesList = ({ info, showVisualCues }) => {
{info.branch ? ORDERS_BRANCH_OPTIONS[info.branch] : ''}
-
Weight allowance
+ Standard weight allowance
{formatWeight(info.totalWeight)}
@@ -104,11 +103,21 @@ const AllowancesList = ({ info, showVisualCues }) => {
Gun Safe
{info.gunSafe ? 'Authorized' : 'Unauthorized'}
+
+
Admin Weight Restricted Location
+ {info.weightRestriction > 0 ? 'Yes' : 'No'}
+
+
+
+
Weight Restriction
+
+ {info.weightRestriction ? formatWeight(info.weightRestriction) : DEFAULT_EMPTY_VALUE}
+
+
);
};
-
AllowancesList.propTypes = {
info: PropTypes.shape({
branch: PropTypes.string,
diff --git a/src/components/Office/DefinitionLists/AllowancesList.test.jsx b/src/components/Office/DefinitionLists/AllowancesList.test.jsx
index 45c2e97f246..9eed73f1d62 100644
--- a/src/components/Office/DefinitionLists/AllowancesList.test.jsx
+++ b/src/components/Office/DefinitionLists/AllowancesList.test.jsx
@@ -19,6 +19,7 @@ const info = {
requiredMedicalEquipmentWeight: 1000,
organizationalClothingAndIndividualEquipment: true,
ubAllowance: 400,
+ weightRestriction: 1500,
};
const initialValuesOconusAdditions = {
@@ -175,4 +176,9 @@ describe('AllowancesList', () => {
expect(screen.getByTestId('unaccompaniedBaggageAllowance')).toBeInTheDocument();
expect(screen.getByTestId('unaccompaniedBaggageAllowance').textContent).toEqual('400 lbs');
});
+ it('renders weight restriction', () => {
+ const adminRestrictedWtLoc = { ...info, adminRestrictedWeightLocation: true };
+ render();
+ expect(screen.getByTestId('weightRestriction').textContent).toEqual('1,500 lbs');
+ });
});
diff --git a/src/constants/MoveHistory/Database/BooleanFields.js b/src/constants/MoveHistory/Database/BooleanFields.js
index 32a4cc5f7c7..c14cb67f56c 100644
--- a/src/constants/MoveHistory/Database/BooleanFields.js
+++ b/src/constants/MoveHistory/Database/BooleanFields.js
@@ -12,6 +12,7 @@ export default {
missing_receipt: 'missing_receipt',
organizational_clothing_and_individual_equipment: 'organizational_clothing_and_individual_equipment',
gun_safe: 'gun_safe',
+ admin_restricted_weight_location: 'admin_restricted_weight_location',
email_is_preferred: 'email_is_preferred',
phone_is_preferred: 'phone_is_preferred',
uses_external_vendor: 'uses_external_vendor',
diff --git a/src/constants/MoveHistory/Database/FieldMappings.js b/src/constants/MoveHistory/Database/FieldMappings.js
index fee085a2b95..aa958199fa7 100644
--- a/src/constants/MoveHistory/Database/FieldMappings.js
+++ b/src/constants/MoveHistory/Database/FieldMappings.js
@@ -39,6 +39,8 @@ export default {
required_medical_equipment_weight: 'Required medical equipment',
organizational_clothing_and_individual_equipment: 'OCIE',
gun_safe: 'Gun Safe',
+ admin_restricted_weight_location: 'Admin restricted weight location',
+ weight_restriction: 'Weight restriction',
requested_pickup_date: 'Requested pickup date',
grade: 'Pay grade',
shipment_type: 'Shipment type',
diff --git a/src/pages/Office/MoveAllowances/MoveAllowances.jsx b/src/pages/Office/MoveAllowances/MoveAllowances.jsx
index 9adf62bdc39..5e7057c752f 100644
--- a/src/pages/Office/MoveAllowances/MoveAllowances.jsx
+++ b/src/pages/Office/MoveAllowances/MoveAllowances.jsx
@@ -43,6 +43,11 @@ const validationSchema = Yup.object({
.min(0, 'Storage in transit (days) must be greater than or equal to 0')
.transform((value) => (Number.isNaN(value) ? 0 : value))
.notRequired(),
+ weightRestriction: Yup.number()
+ .min(1, 'Weight restriction must be greater than 0')
+ .max(18000, 'Weight restriction cannot exceed 18,000 lbs')
+ .transform((value) => (Number.isNaN(value) ? 0 : value))
+ .notRequired(),
});
const MoveAllowances = () => {
@@ -98,6 +103,7 @@ const MoveAllowances = () => {
organizationalClothingAndIndividualEquipment,
storageInTransit,
gunSafe,
+ weightRestriction,
accompaniedTour,
dependentsTwelveAndOver,
dependentsUnderTwelve,
@@ -118,6 +124,7 @@ const MoveAllowances = () => {
organizationalClothingAndIndividualEquipment,
storageInTransit: Number(storageInTransit),
gunSafe,
+ weightRestriction: Number(weightRestriction),
accompaniedTour,
dependentsTwelveAndOver: Number(dependentsTwelveAndOver),
dependentsUnderTwelve: Number(dependentsUnderTwelve),
@@ -133,6 +140,7 @@ const MoveAllowances = () => {
requiredMedicalEquipmentWeight,
organizationalClothingAndIndividualEquipment,
gunSafe,
+ weightRestriction,
storageInTransit,
dependentsUnderTwelve,
dependentsTwelveAndOver,
@@ -148,6 +156,7 @@ const MoveAllowances = () => {
requiredMedicalEquipmentWeight: `${requiredMedicalEquipmentWeight}`,
organizationalClothingAndIndividualEquipment,
gunSafe,
+ weightRestriction: `${weightRestriction}`,
storageInTransit: `${storageInTransit}`,
accompaniedTour,
dependentsUnderTwelve: `${dependentsUnderTwelve}`,
diff --git a/src/pages/Office/MoveDetails/MoveDetails.jsx b/src/pages/Office/MoveDetails/MoveDetails.jsx
index efd341e185c..6e1e9871cd9 100644
--- a/src/pages/Office/MoveDetails/MoveDetails.jsx
+++ b/src/pages/Office/MoveDetails/MoveDetails.jsx
@@ -448,6 +448,7 @@ const MoveDetails = ({
requiredMedicalEquipmentWeight: allowances.requiredMedicalEquipmentWeight,
organizationalClothingAndIndividualEquipment: allowances.organizationalClothingAndIndividualEquipment,
gunSafe: allowances.gunSafe,
+ weightRestriction: allowances.weightRestriction,
dependentsUnderTwelve: allowances.dependentsUnderTwelve,
dependentsTwelveAndOver: allowances.dependentsTwelveAndOver,
accompaniedTour: allowances.accompaniedTour,
diff --git a/src/pages/Office/ServicesCounselingMoveAllowances/ServicesCounselingMoveAllowances.jsx b/src/pages/Office/ServicesCounselingMoveAllowances/ServicesCounselingMoveAllowances.jsx
index 98a85147767..d80502bcd17 100644
--- a/src/pages/Office/ServicesCounselingMoveAllowances/ServicesCounselingMoveAllowances.jsx
+++ b/src/pages/Office/ServicesCounselingMoveAllowances/ServicesCounselingMoveAllowances.jsx
@@ -41,8 +41,29 @@ const validationSchema = Yup.object({
.min(0, 'Storage in transit (days) must be greater than or equal to 0')
.transform((value) => (Number.isNaN(value) ? 0 : value))
.notRequired(),
+ adminRestrictedWeightLocation: Yup.bool(),
+ weightRestriction: Yup.number().when('adminRestrictedWeightLocation', {
+ is: (value) => {
+ return value === true;
+ },
+ then: (schema) => {
+ return schema
+ .required('Weight restriction is required when location is restricted')
+ .min(1, 'Weight restriction must be greater than 0')
+ .max(18000, 'Weight restriction cannot exceed 18,000 lbs')
+ .transform((value) => {
+ return Number.isNaN(value) ? 0 : value;
+ });
+ },
+ otherwise: (schema) => {
+ return schema
+ .transform((value) => {
+ return Number.isNaN(value) ? 0 : value;
+ })
+ .notRequired();
+ },
+ }),
});
-
const ServicesCounselingMoveAllowances = () => {
const { moveCode } = useParams();
const navigate = useNavigate();
@@ -86,6 +107,7 @@ const ServicesCounselingMoveAllowances = () => {
organizationalClothingAndIndividualEquipment,
storageInTransit,
gunSafe,
+ weightRestriction,
accompaniedTour,
dependentsTwelveAndOver,
dependentsUnderTwelve,
@@ -106,6 +128,7 @@ const ServicesCounselingMoveAllowances = () => {
storageInTransit: Number(storageInTransit),
organizationalClothingAndIndividualEquipment,
gunSafe,
+ weightRestriction: Number(weightRestriction),
accompaniedTour,
dependentsTwelveAndOver: Number(dependentsTwelveAndOver),
dependentsUnderTwelve: Number(dependentsUnderTwelve),
@@ -121,6 +144,7 @@ const ServicesCounselingMoveAllowances = () => {
requiredMedicalEquipmentWeight,
organizationalClothingAndIndividualEquipment,
gunSafe,
+ weightRestriction,
storageInTransit,
dependentsUnderTwelve,
dependentsTwelveAndOver,
@@ -136,10 +160,12 @@ const ServicesCounselingMoveAllowances = () => {
requiredMedicalEquipmentWeight: `${requiredMedicalEquipmentWeight}`,
storageInTransit: `${storageInTransit}`,
gunSafe,
+ weightRestriction: `${weightRestriction}`,
organizationalClothingAndIndividualEquipment,
accompaniedTour,
dependentsUnderTwelve: `${dependentsUnderTwelve}`,
dependentsTwelveAndOver: `${dependentsTwelveAndOver}`,
+ adminRestrictedWeightLocation: false,
};
return (
diff --git a/src/pages/Office/ServicesCounselingMoveDetails/ServicesCounselingMoveDetails.jsx b/src/pages/Office/ServicesCounselingMoveDetails/ServicesCounselingMoveDetails.jsx
index 7ab63c0a024..c5104b99537 100644
--- a/src/pages/Office/ServicesCounselingMoveDetails/ServicesCounselingMoveDetails.jsx
+++ b/src/pages/Office/ServicesCounselingMoveDetails/ServicesCounselingMoveDetails.jsx
@@ -387,6 +387,7 @@ const ServicesCounselingMoveDetails = ({
requiredMedicalEquipmentWeight: allowances.requiredMedicalEquipmentWeight,
organizationalClothingAndIndividualEquipment: allowances.organizationalClothingAndIndividualEquipment,
gunSafe: allowances.gunSafe,
+ weightRestriction: allowances.weightRestriction,
dependentsUnderTwelve: allowances.dependentsUnderTwelve,
dependentsTwelveAndOver: allowances.dependentsTwelveAndOver,
accompaniedTour: allowances.accompaniedTour,
diff --git a/swagger-def/definitions/prime/Entitlements.yaml b/swagger-def/definitions/prime/Entitlements.yaml
index 5722870f9d7..83a989da2b8 100644
--- a/swagger-def/definitions/prime/Entitlements.yaml
+++ b/swagger-def/definitions/prime/Entitlements.yaml
@@ -54,6 +54,11 @@ properties:
totalDependents:
example: 2
type: integer
+ weightRestriction:
+ example: 1500
+ type: integer
+ x-formatting: weight
+ x-nullable: true
eTag:
type: string
readOnly: true
diff --git a/swagger-def/ghc.yaml b/swagger-def/ghc.yaml
index 5a7acea828e..285ff9ac571 100644
--- a/swagger-def/ghc.yaml
+++ b/swagger-def/ghc.yaml
@@ -1,4 +1,4 @@
-swagger: '2.0'
+swagger: "2.0"
info:
contact:
email: milmove-developers@caci.com
@@ -6,7 +6,7 @@ info:
$ref: info/ghc_description.md
license:
name: MIT
- url: 'https://opensource.org/licenses/MIT'
+ url: "https://opensource.org/licenses/MIT"
title: MilMove GHC API
version: 0.0.1
basePath: /ghc/v1
@@ -15,7 +15,7 @@ schemes:
tags:
- name: queues
- name: move
- - $ref: 'tags/order.yaml'
+ - $ref: "tags/order.yaml"
- name: moveTaskOrder
- name: customer
- name: mtoServiceItem
@@ -31,7 +31,7 @@ tags:
- name: paymentRequests
- name: reServiceItems
paths:
- '/customer':
+ "/customer":
post:
summary: Creates a customer with Okta option
description: Creates a customer with option to also create an Okta profile account based on the office user's input when completing the UI form and submitting.
@@ -47,28 +47,28 @@ paths:
name: body
required: true
schema:
- $ref: '#/definitions/CreateCustomerPayload'
+ $ref: "#/definitions/CreateCustomerPayload"
responses:
- '200':
+ "200":
description: successfully created the customer
schema:
- $ref: '#/definitions/CreatedCustomer'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/CreatedCustomer"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
/open/requested-office-users:
post:
consumes:
@@ -92,19 +92,19 @@ paths:
name: officeUser
description: Office User information
schema:
- $ref: '#/definitions/OfficeUserCreate'
+ $ref: "#/definitions/OfficeUserCreate"
responses:
- '201':
+ "201":
description: successfully requested the creation of provided office user
schema:
- $ref: '#/definitions/OfficeUser'
- '422':
+ $ref: "#/definitions/OfficeUser"
+ "422":
description: validation error
schema:
- $ref: '#/definitions/ValidationError'
- '500':
+ $ref: "#/definitions/ValidationError"
+ "500":
description: internal server error
- '/customer/{customerID}':
+ "/customer/{customerID}":
parameters:
- description: ID of customer to use
in: path
@@ -117,20 +117,20 @@ paths:
- application/json
parameters: []
responses:
- '200':
+ "200":
description: Successfully retrieved information on an individual customer
schema:
- $ref: '#/definitions/Customer'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/Customer"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- customer
description: Returns a given customer
@@ -151,30 +151,30 @@ paths:
name: body
required: true
schema:
- $ref: '#/definitions/UpdateCustomerPayload'
+ $ref: "#/definitions/UpdateCustomerPayload"
- in: header
name: If-Match
type: string
required: true
responses:
- '200':
+ "200":
description: updated instance of orders
schema:
- $ref: '#/definitions/Customer'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/Customer"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
x-permissions:
- update.customer
/customer/search:
@@ -223,22 +223,30 @@ paths:
sort:
type: string
x-nullable: true
- enum: [customerName, edipi, emplid, branch, personalEmail, telephone]
+ enum:
+ [
+ customerName,
+ edipi,
+ emplid,
+ branch,
+ personalEmail,
+ telephone,
+ ]
order:
type: string
x-nullable: true
enum: [asc, desc]
description: field that results should be sorted by
responses:
- '200':
+ "200":
description: Successfully returned all customers matching the criteria
schema:
- $ref: '#/definitions/SearchCustomersResult'
- '403':
- $ref: '#/responses/PermissionDenied'
- '500':
- $ref: '#/responses/ServerError'
- '/move/{locator}':
+ $ref: "#/definitions/SearchCustomersResult"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "500":
+ $ref: "#/responses/ServerError"
+ "/move/{locator}":
parameters:
- description: Code used to identify a move in the system
in: path
@@ -250,26 +258,26 @@ paths:
- application/json
parameters: []
responses:
- '200':
+ "200":
description: Successfully retrieved the individual move
schema:
- $ref: '#/definitions/Move'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/Move"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- move
description: Returns a given move for a unique alphanumeric locator string
summary: Returns a given move
operationId: getMove
- '/move/{locator}/history':
+ "/move/{locator}/history":
parameters:
- description: Code used to identify a move in the system
in: path
@@ -289,26 +297,26 @@ paths:
type: integer
description: results per page
responses:
- '200':
+ "200":
description: Successfully retrieved the individual move history
schema:
- $ref: '#/definitions/MoveHistoryResult'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/MoveHistoryResult"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- move
description: Returns the history for a given move for a unique alphanumeric locator string
summary: Returns the history of an identified move
operationId: getMoveHistory
- '/moves/{moveID}/shipment-evaluation-reports-list':
+ "/moves/{moveID}/shipment-evaluation-reports-list":
parameters:
- description: Code used to identify a move in the system
in: path
@@ -320,26 +328,26 @@ paths:
produces:
- application/json
responses:
- '200':
+ "200":
description: Successfully retrieved the move's evaluation reports
schema:
- $ref: '#/definitions/EvaluationReportList'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/EvaluationReportList"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- move
description: Returns shipment evaluation reports for the specified move that are visible to the current office user
summary: Returns shipment evaluation reports for the specified move that are visible to the current office user
operationId: getMoveShipmentEvaluationReportsList
- '/moves/{moveID}/counseling-evaluation-reports-list':
+ "/moves/{moveID}/counseling-evaluation-reports-list":
parameters:
- description: Code used to identify a move in the system
in: path
@@ -351,26 +359,26 @@ paths:
produces:
- application/json
responses:
- '200':
+ "200":
description: Successfully retrieved the move's evaluation reports
schema:
- $ref: '#/definitions/EvaluationReportList'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/EvaluationReportList"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- move
description: Returns counseling evaluation reports for the specified move that are visible to the current office user
summary: Returns counseling evaluation reports for the specified move that are visible to the current office user
operationId: getMoveCounselingEvaluationReportsList
- '/moves/{moveID}/cancel':
+ "/moves/{moveID}/cancel":
parameters:
- description: ID of the move
in: path
@@ -385,22 +393,22 @@ paths:
- application/json
parameters: []
responses:
- '200':
+ "200":
description: Successfully canceled move
schema:
- $ref: '#/definitions/Move'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/Move"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- move
description: cancels a move
@@ -408,7 +416,7 @@ paths:
summary: Cancels a move
x-permissions:
- update.cancelMoveFlag
- '/counseling/orders/{orderID}':
+ "/counseling/orders/{orderID}":
parameters:
- description: ID of order to update
in: path
@@ -431,27 +439,27 @@ paths:
name: body
required: true
schema:
- $ref: '#/definitions/CounselingUpdateOrderPayload'
+ $ref: "#/definitions/CounselingUpdateOrderPayload"
- in: header
name: If-Match
type: string
required: true
responses:
- '200':
+ "200":
description: updated instance of orders
schema:
- $ref: '#/definitions/Order'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
- '/orders':
+ $ref: "#/definitions/Order"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
+ "/orders":
post:
summary: Creates an orders model for a logged-in user
description: Creates an instance of orders tied to a service member, which allow for creation of a move and an entitlement. Orders are required before the creation of a move
@@ -466,23 +474,23 @@ paths:
- in: body
name: createOrders
schema:
- $ref: '#/definitions/CreateOrders'
+ $ref: "#/definitions/CreateOrders"
responses:
- '200':
+ "200":
description: created instance of orders
schema:
- $ref: '#/definitions/Order'
- '400':
+ $ref: "#/definitions/Order"
+ "400":
description: invalid request
- '401':
+ "401":
description: request requires user authentication
- '403':
+ "403":
description: user is not authorized
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
description: internal server error
- '/orders/{orderID}':
+ "/orders/{orderID}":
parameters:
- description: ID of order to use
in: path
@@ -505,30 +513,30 @@ paths:
name: body
required: true
schema:
- $ref: '#/definitions/UpdateOrderPayload'
+ $ref: "#/definitions/UpdateOrderPayload"
- in: header
name: If-Match
type: string
required: true
responses:
- '200':
+ "200":
description: updated instance of orders
schema:
- $ref: '#/definitions/Order'
- '400':
- $ref: '#/responses/InvalidRequest'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/Order"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
x-permissions:
- update.orders
get:
@@ -536,26 +544,26 @@ paths:
- application/json
parameters: []
responses:
- '200':
+ "200":
description: Successfully retrieved order
schema:
- $ref: '#/definitions/Order'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/Order"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- order
description: Gets an order
operationId: getOrder
summary: Gets an order by ID
- '/orders/{orderID}/allowances':
+ "/orders/{orderID}/allowances":
parameters:
- description: ID of order to use
in: path
@@ -578,29 +586,29 @@ paths:
name: body
required: true
schema:
- $ref: '#/definitions/UpdateAllowancePayload'
+ $ref: "#/definitions/UpdateAllowancePayload"
- in: header
name: If-Match
type: string
required: true
responses:
- '200':
+ "200":
description: updated instance of allowance
schema:
- $ref: '#/definitions/Order'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/Order"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
x-permissions:
- update.allowances
- '/orders/{orderID}/acknowledge-excess-weight-risk':
+ "/orders/{orderID}/acknowledge-excess-weight-risk":
parameters:
- description: ID of order to use
in: path
@@ -624,23 +632,23 @@ paths:
type: string
required: true
responses:
- '200':
+ "200":
description: updated Move
schema:
- $ref: '#/definitions/Move'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/Move"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
x-permissions:
- update.excessWeightRisk
- '/orders/{orderID}/acknowledge-excess-unaccompanied-baggage-weight-risk':
+ "/orders/{orderID}/acknowledge-excess-unaccompanied-baggage-weight-risk":
parameters:
- description: ID of order to use
in: path
@@ -664,23 +672,23 @@ paths:
type: string
required: true
responses:
- '200':
+ "200":
description: updated Move
schema:
- $ref: '#/definitions/Move'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/Move"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
x-permissions:
- update.excessWeightRisk
- '/orders/{orderID}/update-billable-weight':
+ "/orders/{orderID}/update-billable-weight":
parameters:
- description: ID of order to use
in: path
@@ -703,29 +711,29 @@ paths:
name: body
required: true
schema:
- $ref: '#/definitions/UpdateBillableWeightPayload'
+ $ref: "#/definitions/UpdateBillableWeightPayload"
- in: header
name: If-Match
type: string
required: true
responses:
- '200':
+ "200":
description: updated Order
schema:
- $ref: '#/definitions/Order'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/Order"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
x-permissions:
- update.billableWeight
- '/orders/{orderID}/update-max-billable-weight/tio':
+ "/orders/{orderID}/update-max-billable-weight/tio":
parameters:
- description: ID of order to use
in: path
@@ -748,23 +756,23 @@ paths:
name: body
required: true
schema:
- $ref: '#/definitions/UpdateMaxBillableWeightAsTIOPayload'
- - $ref: 'parameters/ifMatch.yaml'
+ $ref: "#/definitions/UpdateMaxBillableWeightAsTIOPayload"
+ - $ref: "parameters/ifMatch.yaml"
responses:
- '200':
+ "200":
description: updated Order
schema:
- $ref: '#/definitions/Order'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/Order"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
x-permissions:
- update.maxBillableWeight
/orders/{orderID}/upload_amended_orders:
@@ -789,23 +797,23 @@ paths:
description: The file to upload.
required: true
responses:
- '201':
+ "201":
description: created upload
schema:
- $ref: 'definitions/Upload.yaml'
- '400':
+ $ref: "definitions/Upload.yaml"
+ "400":
description: invalid request
schema:
- $ref: '#/definitions/InvalidRequestResponsePayload'
- '403':
+ $ref: "#/definitions/InvalidRequestResponsePayload"
+ "403":
description: not authorized
- '404':
+ "404":
description: not found
- '413':
+ "413":
description: payload is too large
- '500':
+ "500":
description: server error
- '/counseling/orders/{orderID}/allowances':
+ "/counseling/orders/{orderID}/allowances":
parameters:
- description: ID of order to use
in: path
@@ -828,27 +836,27 @@ paths:
name: body
required: true
schema:
- $ref: '#/definitions/CounselingUpdateAllowancePayload'
+ $ref: "#/definitions/CounselingUpdateAllowancePayload"
- in: header
name: If-Match
type: string
required: true
responses:
- '200':
+ "200":
description: updated instance of allowance
schema:
- $ref: '#/definitions/Order'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
- '/move-task-orders/{moveTaskOrderID}':
+ $ref: "#/definitions/Order"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
+ "/move-task-orders/{moveTaskOrderID}":
parameters:
- description: ID of move to use
in: path
@@ -860,26 +868,26 @@ paths:
- application/json
parameters: []
responses:
- '200':
+ "200":
description: Successfully retrieved move task order
schema:
- $ref: '#/definitions/MoveTaskOrder'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/MoveTaskOrder"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- moveTaskOrder
description: Gets a move
operationId: getMoveTaskOrder
summary: Gets a move by ID
- '/move_task_orders/{moveTaskOrderID}/mto_service_items':
+ "/move_task_orders/{moveTaskOrderID}/mto_service_items":
parameters:
- description: ID of move for mto service item to use
in: path
@@ -892,22 +900,22 @@ paths:
- application/json
parameters: []
responses:
- '200':
+ "200":
description: Successfully retrieved all line items for a move task order
schema:
- $ref: 'definitions/MTOServiceItems.yaml'
- '404':
- $ref: '#/responses/NotFound'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/MTOServiceItems.yaml"
+ "404":
+ $ref: "#/responses/NotFound"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- mtoServiceItem
description: Gets all line items for a move
operationId: listMTOServiceItems
summary: Gets all line items for a move
- '/mto-shipments':
+ "/mto-shipments":
post:
summary: createMTOShipment
description: |
@@ -934,21 +942,21 @@ paths:
- in: body
name: body
schema:
- $ref: '#/definitions/CreateMTOShipment'
+ $ref: "#/definitions/CreateMTOShipment"
responses:
- '200':
+ "200":
description: Successfully created a MTO shipment.
schema:
- $ref: 'definitions/MTOShipment.yaml'
- '400':
- $ref: '#/responses/InvalidRequest'
- '404':
- $ref: '#/responses/NotFound'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
- '/move_task_orders/{moveTaskOrderID}/mto_shipments':
+ $ref: "definitions/MTOShipment.yaml"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "404":
+ $ref: "#/responses/NotFound"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
+ "/move_task_orders/{moveTaskOrderID}/mto_shipments":
parameters:
- description: ID of move task order for mto shipment to use
in: path
@@ -961,24 +969,24 @@ paths:
- application/json
parameters: []
responses:
- '200':
+ "200":
description: Successfully retrieved all mto shipments for a move task order
schema:
- $ref: '#/definitions/MTOShipments'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/MTOShipments"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- mtoShipment
description: Gets all shipments for a move task order
operationId: listMTOShipments
summary: Gets all shipments for a move task order
- '/shipments/{shipmentID}':
+ "/shipments/{shipmentID}":
get:
summary: fetches a shipment by ID
description: fetches a shipment by ID
@@ -995,20 +1003,20 @@ paths:
format: uuid
type: string
responses:
- '200':
+ "200":
description: Successfully fetched the shipment
schema:
- $ref: '#/definitions/MTOShipment'
- '400':
- $ref: '#/responses/InvalidRequest'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/MTOShipment"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
delete:
summary: Soft deletes a shipment by ID
description: Soft deletes a shipment by ID
@@ -1025,21 +1033,21 @@ paths:
format: uuid
type: string
responses:
- '204':
+ "204":
description: Successfully soft deleted the shipment
- '400':
- $ref: '#/responses/InvalidRequest'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
- '/move_task_orders/{moveTaskOrderID}/mto_shipments/{shipmentID}':
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
+ "/move_task_orders/{moveTaskOrderID}/mto_shipments/{shipmentID}":
patch:
summary: updateMTOShipment
description: |
@@ -1093,9 +1101,9 @@ paths:
- in: body
name: body
schema:
- $ref: '#/definitions/UpdateShipment'
+ $ref: "#/definitions/UpdateShipment"
responses:
- '200':
+ "200":
description: Successfully updated the specified MTO shipment.
schema:
$ref: 'definitions/MTOShipment.yaml'
@@ -1170,22 +1178,22 @@ paths:
type: string
required: true
responses:
- '200':
+ "200":
description: Successfully approved the shipment
schema:
- $ref: 'definitions/MTOShipment.yaml'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/MTOShipment.yaml"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- shipment
description: Approves a shipment
@@ -1193,7 +1201,7 @@ paths:
summary: Approves a shipment
x-permissions:
- update.shipment
- '/shipments/{shipmentID}/request-diversion':
+ "/shipments/{shipmentID}/request-diversion":
parameters:
- description: ID of the shipment
in: path
@@ -1215,24 +1223,24 @@ paths:
name: body
required: true
schema:
- $ref: '#/definitions/RequestDiversion'
+ $ref: "#/definitions/RequestDiversion"
responses:
- '200':
+ "200":
description: Successfully requested the shipment diversion
schema:
- $ref: 'definitions/MTOShipment.yaml'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/MTOShipment.yaml"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- shipment
description: Requests a shipment diversion
@@ -1240,7 +1248,7 @@ paths:
summary: Requests a shipment diversion
x-permissions:
- create.shipmentDiversionRequest
- '/shipments/{shipmentID}/approve-diversion':
+ "/shipments/{shipmentID}/approve-diversion":
parameters:
- description: ID of the shipment
in: path
@@ -1259,22 +1267,22 @@ paths:
type: string
required: true
responses:
- '200':
+ "200":
description: Successfully approved the shipment diversion
schema:
- $ref: 'definitions/MTOShipment.yaml'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/MTOShipment.yaml"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
x-permissions:
- update.shipment
tags:
@@ -1282,7 +1290,7 @@ paths:
description: Approves a shipment diversion
operationId: approveShipmentDiversion
summary: Approves a shipment diversion
- '/shipments/{shipmentID}/reject':
+ "/shipments/{shipmentID}/reject":
parameters:
- description: ID of the shipment
in: path
@@ -1304,30 +1312,30 @@ paths:
name: body
required: true
schema:
- $ref: '#/definitions/RejectShipment'
+ $ref: "#/definitions/RejectShipment"
responses:
- '200':
+ "200":
description: Successfully rejected the shipment
schema:
- $ref: 'definitions/MTOShipment.yaml'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/MTOShipment.yaml"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- shipment
description: rejects a shipment
operationId: rejectShipment
summary: rejects a shipment
- '/shipments/{shipmentID}/request-cancellation':
+ "/shipments/{shipmentID}/request-cancellation":
parameters:
- description: ID of the shipment
in: path
@@ -1346,22 +1354,22 @@ paths:
type: string
required: true
responses:
- '200':
+ "200":
description: Successfully requested the shipment cancellation
schema:
- $ref: 'definitions/MTOShipment.yaml'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/MTOShipment.yaml"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- shipment
description: Requests a shipment cancellation
@@ -1369,7 +1377,7 @@ paths:
summary: Requests a shipment cancellation
x-permissions:
- create.shipmentCancellation
- '/shipments/{shipmentID}/request-reweigh':
+ "/shipments/{shipmentID}/request-reweigh":
parameters:
- description: ID of the shipment
in: path
@@ -1383,22 +1391,22 @@ paths:
produces:
- application/json
responses:
- '200':
+ "200":
description: Successfully requested a reweigh of the shipment
schema:
- $ref: 'definitions/Reweigh.yaml'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/Reweigh.yaml"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- shipment
- reweigh
@@ -1407,7 +1415,7 @@ paths:
summary: Requests a shipment reweigh
x-permissions:
- create.reweighRequest
- '/shipments/{shipmentID}/review-shipment-address-update':
+ "/shipments/{shipmentID}/review-shipment-address-update":
parameters:
- description: ID of the shipment
in: path
@@ -1441,22 +1449,22 @@ paths:
- officeRemarks
- status
responses:
- '200':
+ "200":
description: Successfully requested a shipment address update
schema:
- $ref: 'definitions/ShipmentAddressUpdate.yaml'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/ShipmentAddressUpdate.yaml"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- shipment
- shipment_address_updates
@@ -1464,7 +1472,7 @@ paths:
Approving the address update will update the Destination Final Address of the associated service item
operationId: reviewShipmentAddressUpdate
summary: Allows TOO to review a shipment address update
- '/shipments/{shipmentID}/sit-extensions':
+ "/shipments/{shipmentID}/sit-extensions":
post:
summary: Create an approved SIT Duration Update
description: TOO can creates an already-approved SIT Duration Update on behalf of a customer
@@ -1486,7 +1494,7 @@ paths:
- in: body
name: body
schema:
- $ref: '#/definitions/CreateApprovedSITDurationUpdate'
+ $ref: "#/definitions/CreateApprovedSITDurationUpdate"
required: true
- in: header
description: We want the shipment's eTag rather than the SIT Duration Update eTag as the SIT Duration Update is always associated with a shipment
@@ -1494,23 +1502,23 @@ paths:
type: string
required: true
responses:
- '200':
+ "200":
description: Successfully created a SIT Extension.
schema:
- $ref: 'definitions/MTOShipment.yaml'
- '400':
- $ref: '#/responses/InvalidRequest'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/MTOShipment.yaml"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
x-permissions:
- create.SITExtension
- '/shipments/{shipmentID}/sit-extensions/{sitExtensionID}/approve':
+ "/shipments/{shipmentID}/sit-extensions/{sitExtensionID}/approve":
parameters:
- description: ID of the shipment
in: path
@@ -1534,29 +1542,29 @@ paths:
name: body
required: true
schema:
- $ref: '#/definitions/ApproveSITExtension'
+ $ref: "#/definitions/ApproveSITExtension"
- in: header
description: We want the shipment's eTag rather than the SIT extension eTag as the SIT extension is always associated with a shipment
name: If-Match
type: string
required: true
responses:
- '200':
+ "200":
description: Successfully approved a SIT extension
schema:
- $ref: 'definitions/MTOShipment.yaml'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/MTOShipment.yaml"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- shipment
- sitExtension
@@ -1565,7 +1573,7 @@ paths:
summary: Approves a SIT extension
x-permissions:
- update.SITExtension
- '/shipments/{shipmentID}/sit-extensions/{sitExtensionID}/deny':
+ "/shipments/{shipmentID}/sit-extensions/{sitExtensionID}/deny":
parameters:
- description: ID of the shipment
in: path
@@ -1589,28 +1597,28 @@ paths:
name: body
required: true
schema:
- $ref: '#/definitions/DenySITExtension'
+ $ref: "#/definitions/DenySITExtension"
- in: header
name: If-Match
type: string
required: true
responses:
- '200':
+ "200":
description: Successfully denied a SIT extension
schema:
- $ref: 'definitions/MTOShipment.yaml'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/MTOShipment.yaml"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- shipment
- sitExtension
@@ -1619,7 +1627,7 @@ paths:
summary: Denies a SIT extension
x-permissions:
- update.SITExtension
- '/shipments/{shipmentID}/sit-service-item/convert-to-customer-expense':
+ "/shipments/{shipmentID}/sit-service-item/convert-to-customer-expense":
parameters:
- description: ID of the shipment
in: path
@@ -1637,28 +1645,28 @@ paths:
name: body
required: true
schema:
- $ref: '#/definitions/UpdateSITServiceItemCustomerExpense'
+ $ref: "#/definitions/UpdateSITServiceItemCustomerExpense"
- in: header
name: If-Match
type: string
required: true
responses:
- '200':
+ "200":
description: Successfully converted to customer expense
schema:
- $ref: 'definitions/MTOShipment.yaml'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/MTOShipment.yaml"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- shipment
- mtoServiceItem
@@ -1688,22 +1696,22 @@ paths:
produces:
- application/json
responses:
- '200':
+ "200":
description: All PPM documents and associated uploads for the specified PPM shipment.
schema:
- $ref: 'definitions/PPMDocuments.yaml'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/PPMDocuments.yaml"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
/ppm-shipments/{ppmShipmentId}/weight-ticket/{weightTicketId}:
parameters:
- - $ref: 'parameters/ppmShipmentId.yaml'
- - $ref: 'parameters/weightTicketId.yaml'
+ - $ref: "parameters/ppmShipmentId.yaml"
+ - $ref: "parameters/weightTicketId.yaml"
patch:
summary: Updates a weight ticket document
description: |
@@ -1717,35 +1725,35 @@ paths:
produces:
- application/json
parameters:
- - $ref: 'parameters/ifMatch.yaml'
+ - $ref: "parameters/ifMatch.yaml"
- in: body
name: updateWeightTicketPayload
required: true
schema:
- $ref: '#/definitions/UpdateWeightTicket'
+ $ref: "#/definitions/UpdateWeightTicket"
responses:
- '200':
+ "200":
description: returns an updated weight ticket object
schema:
- $ref: 'definitions/WeightTicket.yaml'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/WeightTicket.yaml"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
/ppm-shipments/{ppmShipmentId}/moving-expenses/{movingExpenseId}:
parameters:
- - $ref: 'parameters/ppmShipmentId.yaml'
- - $ref: 'parameters/movingExpenseId.yaml'
+ - $ref: "parameters/ppmShipmentId.yaml"
+ - $ref: "parameters/movingExpenseId.yaml"
patch:
summary: Updates the moving expense
description: |
@@ -1759,35 +1767,35 @@ paths:
produces:
- application/json
parameters:
- - $ref: 'parameters/ifMatch.yaml'
+ - $ref: "parameters/ifMatch.yaml"
- in: body
name: updateMovingExpense
required: true
schema:
- $ref: '#/definitions/UpdateMovingExpense'
+ $ref: "#/definitions/UpdateMovingExpense"
responses:
- '200':
+ "200":
description: returns an updated moving expense object
schema:
- $ref: 'definitions/MovingExpense.yaml'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
- /ppm-shipments/{ppmShipmentId}/pro-gear-weight-tickets/{proGearWeightTicketId}:
- parameters:
- - $ref: 'parameters/ppmShipmentId.yaml'
- - $ref: 'parameters/proGearWeightTicketId.yaml'
+ $ref: "definitions/MovingExpense.yaml"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
+ ? /ppm-shipments/{ppmShipmentId}/pro-gear-weight-tickets/{proGearWeightTicketId}
+ : parameters:
+ - $ref: "parameters/ppmShipmentId.yaml"
+ - $ref: "parameters/proGearWeightTicketId.yaml"
patch:
summary: Updates a pro-gear weight ticket
description: |
@@ -1801,31 +1809,31 @@ paths:
produces:
- application/json
parameters:
- - $ref: 'parameters/ifMatch.yaml'
+ - $ref: "parameters/ifMatch.yaml"
- in: body
name: updateProGearWeightTicket
required: true
schema:
- $ref: '#/definitions/UpdateProGearWeightTicket'
+ $ref: "#/definitions/UpdateProGearWeightTicket"
responses:
- '200':
+ "200":
description: returns an updated pro-gear weight ticket object
schema:
- $ref: 'definitions/ProGearWeightTicket.yaml'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/ProGearWeightTicket.yaml"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
/ppm-shipments/{ppmShipmentId}/aoa-packet:
parameters:
- description: the id for the ppmshipment with aoa to be downloaded
@@ -1847,7 +1855,7 @@ paths:
produces:
- application/pdf
responses:
- '200':
+ "200":
headers:
Content-Disposition:
type: string
@@ -1856,19 +1864,19 @@ paths:
schema:
format: binary
type: file
- '400':
- $ref: '#/responses/InvalidRequest'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
/ppm-shipments/{ppmShipmentId}/finish-document-review:
parameters:
- - $ref: 'parameters/ppmShipmentId.yaml'
+ - $ref: "parameters/ppmShipmentId.yaml"
patch:
summary: Updates a PPM shipment's status after document review
description: |
@@ -1886,26 +1894,26 @@ paths:
type: string
required: true
responses:
- '200':
+ "200":
description: Successfully finished document review
schema:
- $ref: 'definitions/PPMShipment.yaml'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/PPMShipment.yaml"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
x-permissions:
- update.shipment
/ppm-shipments/{ppmShipmentId}/ppm-sit:
@@ -1921,7 +1929,7 @@ paths:
produces:
- application/json
parameters:
- - $ref: 'parameters/ppmShipmentId.yaml'
+ - $ref: "parameters/ppmShipmentId.yaml"
- in: header
name: If-Match
type: string
@@ -1929,27 +1937,27 @@ paths:
- in: body
name: body
schema:
- $ref: 'definitions/PPMShipmentSIT.yaml'
+ $ref: "definitions/PPMShipmentSIT.yaml"
responses:
- '200':
+ "200":
description: Successfully finished PPM SIT update
schema:
- $ref: 'definitions/PPMShipment.yaml'
- '400':
- $ref: '#/responses/InvalidRequest'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/PPMShipment.yaml"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
/ppm-shipments/{ppmShipmentId}/closeout:
parameters:
- - $ref: 'parameters/ppmShipmentId.yaml'
+ - $ref: "parameters/ppmShipmentId.yaml"
get:
summary: Get the closeout calcuations for the specified PPM shipment
description: |
@@ -1960,23 +1968,23 @@ paths:
produces:
- application/json
responses:
- '200':
+ "200":
description: Returns closeout for the specified PPM shipment.
schema:
- $ref: 'definitions/PPMCloseout.yaml'
- '400':
- $ref: '#/responses/InvalidRequest'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/PPMCloseout.yaml"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
/ppm-shipments/{ppmShipmentId}/actual-weight:
parameters:
- - $ref: 'parameters/ppmShipmentId.yaml'
+ - $ref: "parameters/ppmShipmentId.yaml"
get:
summary: Get the actual weight for a PPM shipment
description: |
@@ -1987,23 +1995,23 @@ paths:
produces:
- application/json
responses:
- '200':
+ "200":
description: Returns actual weight for the specified PPM shipment.
schema:
- $ref: 'definitions/PPMActualWeight.yaml'
- '400':
- $ref: '#/responses/InvalidRequest'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/PPMActualWeight.yaml"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
/ppm-shipments/{ppmShipmentId}/sit_location/{sitLocation}/sit-estimated-cost:
parameters:
- - $ref: 'parameters/ppmShipmentId.yaml'
+ - $ref: "parameters/ppmShipmentId.yaml"
- in: path
format: string
description: location of sit
@@ -2041,20 +2049,20 @@ paths:
produces:
- application/json
responses:
- '200':
+ "200":
description: Calculates and returns the SIT estimated cost for the specified PPM shipment.
schema:
- $ref: 'definitions/PPMSITEstimatedCost.yaml'
- '400':
- $ref: '#/responses/InvalidRequest'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/PPMSITEstimatedCost.yaml"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
/ppm-shipments/{ppmShipmentId}/payment-packet:
get:
summary: Returns PPM payment packet
@@ -2072,7 +2080,7 @@ paths:
produces:
- application/pdf
responses:
- '200':
+ "200":
headers:
Content-Disposition:
type: string
@@ -2081,17 +2089,17 @@ paths:
schema:
format: binary
type: file
- '400':
+ "400":
description: invalid request
- '401':
+ "401":
description: request requires user authentication
- '403':
+ "403":
description: user is not authorized
- '404':
+ "404":
description: ppm not found
- '500':
+ "500":
description: internal server error
- '/move_task_orders/{moveTaskOrderID}/mto_shipments/{shipmentID}/mto-agents':
+ "/move_task_orders/{moveTaskOrderID}/mto_shipments/{shipmentID}/mto-agents":
parameters:
- description: ID of move task order
in: path
@@ -2110,22 +2118,22 @@ paths:
- application/json
parameters: []
responses:
- '200':
+ "200":
description: Successfully retrieved all agents for a move task order
schema:
- $ref: 'definitions/MTOAgents.yaml'
- '404':
- $ref: '#/responses/NotFound'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/MTOAgents.yaml"
+ "404":
+ $ref: "#/responses/NotFound"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- mtoAgent
description: Fetches a list of agents associated with a move task order.
operationId: fetchMTOAgentList
summary: Fetch move task order agents.
- '/move-task-orders/{moveTaskOrderID}/service-items/{mtoServiceItemID}':
+ "/move-task-orders/{moveTaskOrderID}/service-items/{mtoServiceItemID}":
parameters:
- description: ID of move to use
in: path
@@ -2142,26 +2150,26 @@ paths:
- application/json
parameters: []
responses:
- '200':
+ "200":
description: Successfully retrieved a line item for a move task order by ID
schema:
- $ref: 'definitions/MTOServiceItemSingle.yaml'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/MTOServiceItemSingle.yaml"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- mtoServiceItem
description: Gets a line item by ID for a move by ID
operationId: getMTOServiceItem
summary: Gets a line item by ID for a move by ID
- '/move-task-orders/{moveTaskOrderID}/service-items/{mtoServiceItemID}/status':
+ "/move-task-orders/{moveTaskOrderID}/service-items/{mtoServiceItemID}/status":
parameters:
- description: ID of move to use
in: path
@@ -2183,32 +2191,32 @@ paths:
name: body
required: true
schema:
- $ref: '#/definitions/PatchMTOServiceItemStatusPayload'
+ $ref: "#/definitions/PatchMTOServiceItemStatusPayload"
- in: header
name: If-Match
type: string
required: true
responses:
- '200':
+ "200":
description: >-
Successfully updated status for a line item for a move task order by
ID
schema:
- $ref: 'definitions/MTOServiceItem.yaml'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/MTOServiceItem.yaml"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- mtoServiceItem
description: Changes the status of a line item for a move by ID
@@ -2216,7 +2224,7 @@ paths:
summary: Change the status of a line item for a move by ID
x-permissions:
- update.MTOServiceItem
- '/service-item/{mtoServiceItemID}/entry-date-update':
+ "/service-item/{mtoServiceItemID}/entry-date-update":
parameters:
- description: ID of the service item
in: path
@@ -2233,32 +2241,32 @@ paths:
name: body
required: true
schema:
- $ref: 'definitions/ServiceItemSitEntryDate.yaml'
+ $ref: "definitions/ServiceItemSitEntryDate.yaml"
responses:
- '200':
+ "200":
description: Successfully updated SIT entry date
schema:
- $ref: 'definitions/MTOServiceItemSingle.yaml'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/MTOServiceItemSingle.yaml"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- mtoServiceItem
description: Locates the service item in the database and updates the SIT entry date for the selected service item and returns the service item
operationId: updateServiceItemSitEntryDate
summary: Updates a service item's SIT entry date by ID
- '/move-task-orders/{moveTaskOrderID}/status':
+ "/move-task-orders/{moveTaskOrderID}/status":
patch:
consumes:
- application/json
@@ -2277,29 +2285,29 @@ paths:
- in: body
name: serviceItemCodes
schema:
- $ref: '#/definitions/MTOApprovalServiceItemCodes'
+ $ref: "#/definitions/MTOApprovalServiceItemCodes"
required: true
responses:
- '200':
+ "200":
description: Successfully updated move task order status
schema:
- $ref: '#/definitions/Move'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/Move"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- moveTaskOrder
description: Changes move task order status
@@ -2308,7 +2316,7 @@ paths:
x-permissions:
- update.move
- create.serviceItem
- '/move-task-orders/{moveTaskOrderID}/status/service-counseling-completed':
+ "/move-task-orders/{moveTaskOrderID}/status/service-counseling-completed":
patch:
consumes:
- application/json
@@ -2325,33 +2333,33 @@ paths:
type: string
required: true
responses:
- '200':
+ "200":
description: Successfully updated move task order status
schema:
- $ref: '#/definitions/Move'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/Move"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- moveTaskOrder
description: Changes move (move task order) status to service counseling completed
operationId: updateMTOStatusServiceCounselingCompleted
summary: Changes move (move task order) status to service counseling completed
- '/move-task-orders/{moveTaskOrderID}/payment-service-items/{paymentServiceItemID}/status':
- parameters:
+ ? "/move-task-orders/{moveTaskOrderID}/payment-service-items/{paymentServiceItemID}/status"
+ : parameters:
- description: ID of move to use
in: path
name: moveTaskOrderID
@@ -2372,32 +2380,32 @@ paths:
name: body
required: true
schema:
- $ref: '#/definitions/PaymentServiceItem'
+ $ref: "#/definitions/PaymentServiceItem"
- in: header
name: If-Match
type: string
required: true
responses:
- '200':
+ "200":
description: >-
Successfully updated status for a line item for a move task order by
ID
schema:
- $ref: '#/definitions/PaymentServiceItem'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/PaymentServiceItem"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- paymentServiceItem
description: Changes the status of a line item for a move by ID
@@ -2405,7 +2413,7 @@ paths:
summary: Change the status of a payment service item for a move by ID
x-permissions:
- update.paymentServiceItemStatus
- '/move-task-orders/{moveTaskOrderID}/billable-weights-reviewed-at':
+ "/move-task-orders/{moveTaskOrderID}/billable-weights-reviewed-at":
patch:
consumes:
- application/json
@@ -2422,31 +2430,31 @@ paths:
type: string
required: true
responses:
- '200':
+ "200":
description: Successfully updated move task order billableWeightsReviewedAt field
schema:
- $ref: '#/definitions/Move'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/Move"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- moveTaskOrder
description: Changes move (move task order) billableWeightsReviewedAt field to a timestamp
operationId: updateMTOReviewedBillableWeightsAt
- '/move-task-orders/{moveTaskOrderID}/tio-remarks':
+ "/move-task-orders/{moveTaskOrderID}/tio-remarks":
patch:
consumes:
- application/json
@@ -2466,33 +2474,33 @@ paths:
name: body
required: true
schema:
- $ref: '#/definitions/Move'
+ $ref: "#/definitions/Move"
responses:
- '200':
+ "200":
description: Successfully updated move task order tioRemarks field
schema:
- $ref: '#/definitions/Move'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/Move"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- moveTaskOrder
description: Changes move (move task order) billableWeightsReviewedAt field to a timestamp
operationId: updateMoveTIORemarks
- '/move-task-orders/{moveTaskOrderID}/entitlements':
+ "/move-task-orders/{moveTaskOrderID}/entitlements":
parameters:
- description: ID of move to use
in: path
@@ -2506,24 +2514,24 @@ paths:
tags:
- moveTaskOrder
responses:
- '200':
+ "200":
description: Successfully retrieved entitlements
schema:
- $ref: '#/definitions/Entitlements'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/Entitlements"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
description: Gets entitlements
operationId: getEntitlements
summary: Gets entitlements for a move by ID
- '/payment-requests/{paymentRequestID}':
+ "/payment-requests/{paymentRequestID}":
parameters:
- description: UUID of payment request
format: uuid
@@ -2536,20 +2544,20 @@ paths:
- application/json
parameters: []
responses:
- '200':
+ "200":
description: fetched instance of payment request
schema:
- $ref: '#/definitions/PaymentRequest'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/PaymentRequest"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- paymentRequests
description: Fetches an instance of a payment request by id
@@ -2557,7 +2565,7 @@ paths:
summary: Fetches a payment request by id
x-permissions:
- read.paymentRequest
- '/moves/{locator}/closeout-office':
+ "/moves/{locator}/closeout-office":
parameters:
- description: move code to identify a move to update the PPM shipment's closeout office for Army and Air Force service members
format: string
@@ -2592,25 +2600,25 @@ paths:
type: string
required: true
responses:
- '200':
+ "200":
description: Successfully set the closeout office for the move
schema:
- $ref: '#/definitions/Move'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
- '/moves/{locator}/customer-support-remarks':
+ $ref: "#/definitions/Move"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
+ "/moves/{locator}/customer-support-remarks":
parameters:
- description: move code to identify a move for customer support remarks
format: string
@@ -2627,20 +2635,20 @@ paths:
- in: body
name: body
schema:
- $ref: '#/definitions/CreateCustomerSupportRemark'
+ $ref: "#/definitions/CreateCustomerSupportRemark"
responses:
- '200':
+ "200":
description: Successfully created customer support remark
schema:
- $ref: 'definitions/CustomerSupportRemark.yaml'
- '400':
- $ref: '#/responses/InvalidRequest'
- '404':
- $ref: '#/responses/NotFound'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/CustomerSupportRemark.yaml"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "404":
+ $ref: "#/responses/NotFound"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- customerSupportRemarks
description: Creates a customer support remark for a move
@@ -2651,24 +2659,24 @@ paths:
- application/json
parameters: []
responses:
- '200':
+ "200":
description: Successfully retrieved all line items for a move task order
schema:
- $ref: 'definitions/CustomerSupportRemarks.yaml'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/CustomerSupportRemarks.yaml"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- customerSupportRemarks
description: Fetches customer support remarks for a move
operationId: getCustomerSupportRemarksForMove
summary: Fetches customer support remarks using the move code (locator).
- '/customer-support-remarks/{customerSupportRemarkID}':
+ "/customer-support-remarks/{customerSupportRemarkID}":
parameters:
- in: path
description: the customer support remark ID to be modified
@@ -2691,22 +2699,22 @@ paths:
name: body
required: true
schema:
- $ref: '#/definitions/UpdateCustomerSupportRemarkPayload'
+ $ref: "#/definitions/UpdateCustomerSupportRemarkPayload"
responses:
- '200':
+ "200":
description: Successfully updated customer support remark
schema:
- $ref: 'definitions/CustomerSupportRemark.yaml'
- '400':
- $ref: '#/responses/InvalidRequest'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/CustomerSupportRemark.yaml"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
delete:
summary: Soft deletes a customer support remark by ID
description: Soft deletes a customer support remark by ID
@@ -2716,21 +2724,21 @@ paths:
produces:
- application/json
responses:
- '204':
+ "204":
description: Successfully soft deleted the shipment
- '400':
- $ref: '#/responses/InvalidRequest'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
- '/moves/{locator}/evaluation-reports':
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
+ "/moves/{locator}/evaluation-reports":
parameters:
- in: path
name: locator
@@ -2745,20 +2753,20 @@ paths:
- in: body
name: body
schema:
- $ref: '#/definitions/CreateEvaluationReport'
+ $ref: "#/definitions/CreateEvaluationReport"
responses:
- '200':
+ "200":
description: Successfully created evaluation report
schema:
- $ref: '#/definitions/EvaluationReport'
- '400':
- $ref: '#/responses/InvalidRequest'
- '404':
- $ref: '#/responses/NotFound'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/EvaluationReport"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "404":
+ $ref: "#/responses/NotFound"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
x-permissions:
- create.evaluationReport
tags:
@@ -2766,7 +2774,7 @@ paths:
description: Creates an evaluation report
operationId: createEvaluationReport
summary: Creates an evaluation report
- '/evaluation-reports/{reportID}/download':
+ "/evaluation-reports/{reportID}/download":
parameters:
- in: path
description: the evaluation report ID to be downloaded
@@ -2783,7 +2791,7 @@ paths:
produces:
- application/pdf
responses:
- '200':
+ "200":
headers:
Content-Disposition:
type: string
@@ -2792,13 +2800,13 @@ paths:
schema:
format: binary
type: file
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
- '/evaluation-reports/{reportID}':
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
+ "/evaluation-reports/{reportID}":
parameters:
- in: path
description: the evaluation report ID to be modified
@@ -2815,18 +2823,18 @@ paths:
produces:
- application/json
responses:
- '200':
+ "200":
description: Successfully got the report
schema:
- $ref: '#/definitions/EvaluationReport'
- '400':
- $ref: '#/responses/InvalidRequest'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/EvaluationReport"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
delete:
summary: Deletes an evaluation report by ID
description: Deletes an evaluation report by ID
@@ -2838,20 +2846,20 @@ paths:
produces:
- application/json
responses:
- '204':
+ "204":
description: Successfully deleted the report
- '400':
- $ref: '#/responses/InvalidRequest'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
put:
summary: Saves an evaluation report as a draft
description: Saves an evaluation report as a draft
@@ -2868,7 +2876,7 @@ paths:
- in: body
name: body
schema:
- $ref: '#/definitions/EvaluationReport'
+ $ref: "#/definitions/EvaluationReport"
- in: header
name: If-Match
type: string
@@ -2877,23 +2885,23 @@ paths:
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.
responses:
- '204':
+ "204":
description: Successfully saved the report
- '400':
- $ref: '#/responses/InvalidRequest'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
- '/evaluation-reports/{reportID}/submit':
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
+ "/evaluation-reports/{reportID}/submit":
parameters:
- in: path
description: the evaluation report ID to be modified
@@ -2918,21 +2926,21 @@ paths:
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.
responses:
- '204':
+ "204":
description: Successfully submitted an evaluation report with the provided ID
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
x-permissions:
- update.evaluationReport
- '/evaluation-reports/{reportID}/appeal/add':
+ "/evaluation-reports/{reportID}/appeal/add":
parameters:
- in: path
description: the evaluation report ID
@@ -2954,23 +2962,23 @@ paths:
- in: body
name: body
schema:
- $ref: '#/definitions/CreateAppeal'
+ $ref: "#/definitions/CreateAppeal"
responses:
- '204':
+ "204":
description: Successfully added an appeal to a serious incident
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
x-permissions:
- update.evaluationReport
- '/evaluation-reports/{reportID}/{reportViolationID}/appeal/add':
+ "/evaluation-reports/{reportID}/{reportViolationID}/appeal/add":
parameters:
- in: path
description: the evaluation report ID
@@ -2998,23 +3006,23 @@ paths:
- in: body
name: body
schema:
- $ref: '#/definitions/CreateAppeal'
+ $ref: "#/definitions/CreateAppeal"
responses:
- '204':
+ "204":
description: Successfully added an appeal to a violation
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
x-permissions:
- update.evaluationReport
- '/pws-violations':
+ "/pws-violations":
get:
summary: Fetch the possible PWS violations for an evaluation report
description: Fetch the possible PWS violations for an evaluation report
@@ -3024,19 +3032,19 @@ paths:
produces:
- application/json
responses:
- '200':
+ "200":
description: Successfully retrieved the PWS violations
schema:
- $ref: '#/definitions/PWSViolations'
- '400':
- $ref: '#/responses/InvalidRequest'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
- '/report-violations/{reportID}':
+ $ref: "#/definitions/PWSViolations"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
+ "/report-violations/{reportID}":
parameters:
- in: path
description: the evaluation report ID that has associated violations
@@ -3053,18 +3061,18 @@ paths:
produces:
- application/json
responses:
- '200':
+ "200":
description: Successfully retrieved the report violations
schema:
- $ref: '#/definitions/ReportViolations'
- '400':
- $ref: '#/responses/InvalidRequest'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/ReportViolations"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
post:
summary: Associate violations with an evaluation report
description: >-
@@ -3083,25 +3091,25 @@ paths:
- in: body
name: body
schema:
- $ref: '#/definitions/AssociateReportViolations'
+ $ref: "#/definitions/AssociateReportViolations"
responses:
- '204':
+ "204":
description: Successfully saved the report violations
- '400':
- $ref: '#/responses/InvalidRequest'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '409':
- $ref: '#/responses/Conflict'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "409":
+ $ref: "#/responses/Conflict"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
x-permissions:
- create.reportViolation
- '/moves/{locator}/payment-requests':
+ "/moves/{locator}/payment-requests":
parameters:
- description: move code to identify a move for payment requests
format: string
@@ -3113,19 +3121,19 @@ paths:
produces:
- application/json
parameters: []
- responses:
- '200':
- description: Successfully retrieved all line items for a move task order
- schema:
- $ref: '#/definitions/PaymentRequests'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ responses:
+ "200":
+ description: Successfully retrieved all line items for a move task order
+ schema:
+ $ref: "#/definitions/PaymentRequests"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- paymentRequests
description: Fetches payment requests for a move
@@ -3133,7 +3141,7 @@ paths:
summary: Fetches payment requests using the move code (locator).
x-permissions:
- read.paymentRequest
- '/moves/{moveID}/financial-review-flag':
+ "/moves/{moveID}/financial-review-flag":
parameters:
- description: ID of move to flag
in: path
@@ -3171,20 +3179,20 @@ paths:
example: false
type: boolean
responses:
- '200':
+ "200":
description: updated Move
schema:
- $ref: '#/definitions/Move'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/Move"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
x-permissions:
- update.financialReviewFlag
/moves/{moveID}/uploadAdditionalDocuments:
@@ -3209,25 +3217,25 @@ paths:
description: The file to upload.
required: true
responses:
- '201':
+ "201":
description: created upload
schema:
- $ref: 'definitions/Upload.yaml'
- '400':
+ $ref: "definitions/Upload.yaml"
+ "400":
description: invalid request
schema:
- $ref: '#/definitions/InvalidRequestResponsePayload'
- '403':
+ $ref: "#/definitions/InvalidRequestResponsePayload"
+ "403":
description: not authorized
- '404':
+ "404":
description: not found
- '413':
+ "413":
description: payload is too large
- '500':
+ "500":
description: server error
x-permissions:
- create.supportingDocuments
- '/payment-requests/{paymentRequestID}/shipments-payment-sit-balance':
+ "/payment-requests/{paymentRequestID}/shipments-payment-sit-balance":
parameters:
- description: payment request ID of the payment request with SIT service items being reviewed
name: paymentRequestID
@@ -3240,18 +3248,18 @@ paths:
- application/json
parameters: []
responses:
- '200':
+ "200":
description: Successfully retrieved shipments and their SIT days balance from all payment requests on the move
schema:
- $ref: '#/definitions/ShipmentsPaymentSITBalance'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/ShipmentsPaymentSITBalance"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- paymentRequests
description: Returns all shipment payment request SIT usage to support partial SIT invoicing
@@ -3259,7 +3267,7 @@ paths:
summary: Returns all shipment payment request SIT usage to support partial SIT invoicing
x-permissions:
- read.shipmentsPaymentSITBalance
- '/payment-requests/{paymentRequestID}/status':
+ "/payment-requests/{paymentRequestID}/status":
patch:
consumes:
- application/json
@@ -3276,30 +3284,30 @@ paths:
name: body
required: true
schema:
- $ref: '#/definitions/UpdatePaymentRequestStatusPayload'
+ $ref: "#/definitions/UpdatePaymentRequestStatusPayload"
- in: header
name: If-Match
type: string
required: true
responses:
- '200':
+ "200":
description: updated payment request
schema:
- $ref: '#/definitions/PaymentRequest'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/PaymentRequest"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- paymentRequests
description: Updates status of a payment request by id
@@ -3307,7 +3315,7 @@ paths:
summary: Updates status of a payment request by id
x-permissions:
- update.paymentRequest
- '/payment-requests/{paymentRequestID}/bulkDownload':
+ "/payment-requests/{paymentRequestID}/bulkDownload":
parameters:
- description: the id for the payment-request with files to be downloaded
in: path
@@ -3324,7 +3332,7 @@ paths:
produces:
- application/pdf
responses:
- '200':
+ "200":
headers:
Content-Disposition:
type: string
@@ -3333,10 +3341,10 @@ paths:
schema:
format: binary
type: file
- '400':
- $ref: '#/responses/InvalidRequest'
- '500':
- $ref: '#/responses/ServerError'
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "500":
+ $ref: "#/responses/ServerError"
/documents/{documentId}:
get:
summary: Returns a document
@@ -3352,24 +3360,24 @@ paths:
required: true
description: UUID of the document to return
responses:
- '200':
+ "200":
description: the requested document
schema:
- $ref: 'definitions/Document.yaml'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '412':
- $ref: '#/responses/PreconditionFailed'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/Document.yaml"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "412":
+ $ref: "#/responses/PreconditionFailed"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
/documents:
post:
summary: Create a new document
@@ -3382,17 +3390,17 @@ paths:
name: documentPayload
required: true
schema:
- $ref: '#/definitions/PostDocumentPayload'
+ $ref: "#/definitions/PostDocumentPayload"
responses:
- '201':
+ "201":
description: created document
schema:
- $ref: 'definitions/Document.yaml'
- '400':
+ $ref: "definitions/Document.yaml"
+ "400":
description: invalid request
- '403':
- $ref: '#/responses/PermissionDenied'
- '500':
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "500":
description: server error
/queues/counseling:
get:
@@ -3543,14 +3551,14 @@ paths:
description: |
Used to illustrate which user is assigned to this payment request.
responses:
- '200':
+ "200":
description: Successfully returned all moves matching the criteria
schema:
- $ref: '#/definitions/QueueMovesResult'
- '403':
- $ref: '#/responses/PermissionDenied'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/QueueMovesResult"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "500":
+ $ref: "#/responses/ServerError"
/queues/bulk-assignment:
get:
produces:
@@ -3572,7 +3580,7 @@ paths:
- TASK_ORDER
- PAYMENT_REQUEST
responses:
- '200':
+ "200":
description: Successfully returned bulk assignment data
schema:
$ref: '#/definitions/BulkAssignmentData'
@@ -3602,14 +3610,14 @@ paths:
type: string
description: Used to return an origins list for a GBLOC other than the default of the current user. Requires the HQ role or a secondary transportation office assignment. The parameter is ignored if the requesting user does not have the necessary role or assignment.
responses:
- '200':
+ "200":
description: Successfully returned all moves matching the criteria
schema:
- $ref: '#/definitions/Locations'
- '403':
- $ref: '#/responses/PermissionDenied'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/Locations"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "500":
+ $ref: "#/responses/ServerError"
/queues/prime-moves:
get:
summary: getPrimeMovesQueue
@@ -3651,14 +3659,14 @@ paths:
type: string
description: order type
responses:
- '200':
+ "200":
description: Successfully retrieved moves. A successful fetch might still return zero moves.
schema:
- $ref: '#/definitions/ListPrimeMovesResult'
- '403':
- $ref: '#/responses/PermissionDenied'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/ListPrimeMovesResult"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "500":
+ $ref: "#/responses/ServerError"
/queues/moves:
get:
produces:
@@ -3765,14 +3773,14 @@ paths:
type: string
description: filters using a counselingOffice name of the move
responses:
- '200':
+ "200":
description: Successfully returned all moves matching the criteria
schema:
- $ref: '#/definitions/QueueMovesResult'
- '403':
- $ref: '#/responses/PermissionDenied'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/QueueMovesResult"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "500":
+ $ref: "#/responses/ServerError"
/queues/payment-requests:
get:
produces:
@@ -3787,7 +3795,20 @@ paths:
- in: query
name: sort
type: string
- enum: [customerName, locator, submittedAt, branch, status, edipi, emplid, age, originDutyLocation, assignedTo, counselingOffice]
+ enum:
+ [
+ customerName,
+ locator,
+ submittedAt,
+ branch,
+ status,
+ edipi,
+ emplid,
+ age,
+ originDutyLocation,
+ assignedTo,
+ counselingOffice,
+ ]
description: field that results should be sorted by
- in: query
name: order
@@ -3861,14 +3882,14 @@ paths:
description: |
Used to return a queue for a GBLOC other than the default of the current user. Requires the HQ role or a secondary transportation office assignment. The parameter is ignored if the requesting user does not have the necessary role or assignment.
responses:
- '200':
+ "200":
description: Successfully returned all moves matching the criteria
schema:
- $ref: '#/definitions/QueuePaymentRequestsResult'
- '403':
- $ref: '#/responses/PermissionDenied'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/QueuePaymentRequestsResult"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "500":
+ $ref: "#/responses/ServerError"
/moves/search:
post:
produces:
@@ -3973,15 +3994,15 @@ paths:
enum: [asc, desc]
description: field that results should be sorted by
responses:
- '200':
+ "200":
description: Successfully returned all moves matching the criteria
schema:
- $ref: '#/definitions/SearchMovesResult'
- '403':
- $ref: '#/responses/PermissionDenied'
- '500':
- $ref: '#/responses/ServerError'
- '/tac/valid':
+ $ref: "#/definitions/SearchMovesResult"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "500":
+ $ref: "#/responses/ServerError"
+ "/tac/valid":
get:
summary: Validation of a TAC value
description: Returns a boolean based on whether a tac value is valid or not
@@ -3996,23 +4017,23 @@ paths:
required: true
description: The tac value to validate
responses:
- '200':
+ "200":
description: Successfully retrieved validation status
schema:
- $ref: '#/definitions/TacValid'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/TacValid"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
/lines-of-accounting:
post:
- summary: 'Fetch line of accounting'
+ summary: "Fetch line of accounting"
description: >
Fetches a line of accounting based on provided service member affiliation, effective date, and Transportation Accounting Code (TAC).
It uses these parameters to filter the correct Line of Accounting for the provided TAC. It does this by filtering
@@ -4024,33 +4045,33 @@ paths:
tags:
- linesOfAccounting
consumes:
- - 'application/json'
+ - "application/json"
produces:
- - 'application/json'
+ - "application/json"
parameters:
- - in: 'body'
- name: 'body'
- description: 'Service member affiliation, effective date, and TAC code.'
+ - in: "body"
+ name: "body"
+ description: "Service member affiliation, effective date, and TAC code."
required: true
schema:
- $ref: '#/definitions/FetchLineOfAccountingPayload'
+ $ref: "#/definitions/FetchLineOfAccountingPayload"
responses:
- '200':
- description: 'Successfully retrieved line of accounting'
- schema:
- $ref: 'definitions/LineOfAccounting.yaml'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '422':
- $ref: '#/responses/UnprocessableEntity'
- '500':
- $ref: '#/responses/ServerError'
+ "200":
+ description: "Successfully retrieved line of accounting"
+ schema:
+ $ref: "definitions/LineOfAccounting.yaml"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "422":
+ $ref: "#/responses/UnprocessableEntity"
+ "500":
+ $ref: "#/responses/ServerError"
/transportation-offices:
get:
produces:
@@ -4068,20 +4089,20 @@ paths:
minLength: 2
description: Search string for transportation offices
responses:
- '200':
+ "200":
description: Successfully retrieved transportation offices
schema:
- $ref: '#/definitions/TransportationOffices'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/TransportationOffices"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
/open/transportation-offices:
get:
produces:
@@ -4099,20 +4120,20 @@ paths:
minLength: 2
description: Search string for transportation offices
responses:
- '200':
+ "200":
description: Successfully retrieved transportation offices
schema:
- $ref: '#/definitions/TransportationOffices'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/TransportationOffices"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
/transportation-offices/gblocs:
get:
produces:
@@ -4123,20 +4144,20 @@ paths:
tags:
- transportationOffice
responses:
- '200':
+ "200":
description: Successfully retrieved transportation offices
schema:
- $ref: '#/definitions/GBLOCs'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/GBLOCs"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
/addresses/zip-city-lookup/{search}:
get:
summary: Returns city, state, postal code, and county associated with the specified full/partial postal code or city and state string
@@ -4145,23 +4166,23 @@ paths:
tags:
- addresses
parameters:
- - in: path
- name: search
- type: string
- required: true
+ - in: path
+ name: search
+ type: string
+ required: true
responses:
- '200':
+ "200":
description: the requested list of city, state, county, and postal code matches
schema:
$ref: "#/definitions/VLocations"
- '400':
- $ref: '#/responses/InvalidRequest'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
/uploads:
post:
summary: Create a new upload
@@ -4186,19 +4207,19 @@ paths:
description: The file to upload.
required: true
responses:
- '201':
+ "201":
description: created upload
schema:
- $ref: 'definitions/Upload.yaml'
- '400':
+ $ref: "definitions/Upload.yaml"
+ "400":
description: invalid request
- '403':
+ "403":
description: not authorized
- '404':
+ "404":
description: not found
- '413':
+ "413":
description: payload is too large
- '500':
+ "500":
description: server error
/re-service-items:
get:
@@ -4210,18 +4231,18 @@ paths:
tags:
- reServiceItems
responses:
- '200':
+ "200":
description: Successfully retrieved all ReServiceItems.
schema:
- $ref: '#/definitions/ReServiceItems'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/ReServiceItems"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
/uploads/{uploadID}:
delete:
summary: Deletes an upload
@@ -4242,17 +4263,17 @@ paths:
format: uuid
description: ID of the order that the upload belongs to
responses:
- '204':
+ "204":
description: deleted
- '400':
+ "400":
description: invalid request
schema:
- $ref: '#/definitions/InvalidRequestResponsePayload'
- '403':
+ $ref: "#/definitions/InvalidRequestResponsePayload"
+ "403":
description: not authorized
- '404':
+ "404":
description: not found
- '500':
+ "500":
description: server error
/uploads/get/:
get:
@@ -4260,20 +4281,20 @@ paths:
- application/json
parameters: []
responses:
- '200':
+ "200":
description: Successfully retrieved upload
schema:
- $ref: 'definitions/Upload.yaml'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '403':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "definitions/Upload.yaml"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "403":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- uploads
description: Gets an upload
@@ -4308,19 +4329,19 @@ paths:
minimum: 0
maximum: 3
responses:
- '201':
+ "201":
description: updated upload
schema:
- $ref: 'definitions/Upload.yaml'
- '400':
+ $ref: "definitions/Upload.yaml"
+ "400":
description: invalid request
- '403':
+ "403":
description: not authorized
- '404':
+ "404":
description: not found
- '413':
+ "413":
description: payload is too large
- '500':
+ "500":
description: server error
/application_parameters/{parameterName}:
get:
@@ -4337,15 +4358,15 @@ paths:
required: true
description: Parameter Name
responses:
- '200':
+ "200":
description: Application Parameters
schema:
- $ref: '#/definitions/ApplicationParameters'
- '400':
+ $ref: "#/definitions/ApplicationParameters"
+ "400":
description: invalid request
- '401':
+ "401":
description: request requires user authentication
- '500':
+ "500":
description: server error
/calendar/{countryCode}/is-weekend-holiday/{date}:
get:
@@ -4372,18 +4393,18 @@ paths:
type: string
format: date
responses:
- '200':
+ "200":
description: Successfully determine if given date is weekend and/or holiday for given country.
schema:
- $ref: '#/definitions/IsDateWeekendHolidayInfo'
- '400':
- $ref: '#/responses/InvalidRequest'
- '401':
- $ref: '#/responses/PermissionDenied'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/IsDateWeekendHolidayInfo"
+ "400":
+ $ref: "#/responses/InvalidRequest"
+ "401":
+ $ref: "#/responses/PermissionDenied"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
/moves/{moveID}/assignOfficeUser:
parameters:
- description: ID of the move
@@ -4402,16 +4423,16 @@ paths:
name: body
required: true
schema:
- $ref: '#/definitions/AssignOfficeUserBody'
+ $ref: "#/definitions/AssignOfficeUserBody"
responses:
- '200':
+ "200":
description: Successfully assigned office user to the move
schema:
- $ref: '#/definitions/Move'
- '404':
- $ref: '#/responses/NotFound'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/Move"
+ "404":
+ $ref: "#/responses/NotFound"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- move
description: assigns either a services counselor, task ordering officer, or task invoicing officer to the move
@@ -4438,12 +4459,12 @@ paths:
produces:
- application/json
responses:
- '200':
+ "200":
description: Successfully unassigned office user from the move
schema:
- $ref: '#/definitions/Move'
- '500':
- $ref: '#/responses/ServerError'
+ $ref: "#/definitions/Move"
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- move
description: unassigns either a services counselor, task ordering officer, or task invoicing officer from the move
@@ -4462,7 +4483,7 @@ paths:
produces:
- application/json
responses:
- '200':
+ "200":
description: Successfully unlocked officer's move(s).
schema:
type: object
@@ -4470,8 +4491,8 @@ paths:
successMessage:
type: string
example: OK
- '500':
- $ref: '#/responses/ServerError'
+ "500":
+ $ref: "#/responses/ServerError"
tags:
- move
description: >-
@@ -4523,7 +4544,7 @@ definitions:
- instance
ValidationError:
allOf:
- - $ref: '#/definitions/ClientError'
+ - $ref: "#/definitions/ClientError"
- type: object
properties:
invalid_fields:
@@ -4615,17 +4636,17 @@ definitions:
type: string
format: uuid
transportationOffice:
- $ref: 'definitions/TransportationOffice.yaml'
+ $ref: "definitions/TransportationOffice.yaml"
transportationOfficeAssignments:
type: array
items:
- $ref: 'definitions/TransportationOfficeAssignment.yaml'
+ $ref: "definitions/TransportationOfficeAssignment.yaml"
active:
type: boolean
roles:
type: array
items:
- $ref: '#/definitions/Role'
+ $ref: "#/definitions/Role"
edipi:
type: string
otherUniqueId:
@@ -4673,18 +4694,18 @@ definitions:
type: string
format: uuid
transportationOffice:
- $ref: 'definitions/TransportationOffice.yaml'
+ $ref: "definitions/TransportationOffice.yaml"
OfficeUserCreate:
type: object
properties:
email:
type: string
- example: 'user@userdomain.com'
+ example: "user@userdomain.com"
title: Email
x-nullable: false
edipi:
type: string
- example: '1234567890'
+ example: "1234567890"
maxLength: 10
title: EDIPI
x-nullable: true
@@ -4714,12 +4735,12 @@ definitions:
transportationOfficeId:
type: string
format: uuid
- example: 'c56a4180-65aa-42ec-a945-5fd21dec0538'
+ example: "c56a4180-65aa-42ec-a945-5fd21dec0538"
x-nullable: false
roles:
type: array
items:
- $ref: '#/definitions/OfficeUserRole'
+ $ref: "#/definitions/OfficeUserRole"
x-nullable: false
required:
- firstName
@@ -4733,12 +4754,12 @@ definitions:
properties:
name:
type: string
- example: 'Task Ordering Officer'
+ example: "Task Ordering Officer"
x-nullable: true
title: name
roleType:
type: string
- example: 'task_ordering_officer'
+ example: "task_ordering_officer"
x-nullable: true
title: roleType
Customer:
@@ -4772,9 +4793,9 @@ definitions:
example: David
x-nullable: true
current_address:
- $ref: 'definitions/Address.yaml'
+ $ref: "definitions/Address.yaml"
backup_contact:
- $ref: '#/definitions/BackupContact'
+ $ref: "#/definitions/BackupContact"
id:
type: string
format: uuid
@@ -4797,7 +4818,7 @@ definitions:
pattern: '^[2-9]\d{2}-\d{3}-\d{4}$|^$'
x-nullable: true
backupAddress:
- $ref: 'definitions/Address.yaml'
+ $ref: "definitions/Address.yaml"
cacValidated:
type: boolean
x-nullable: true
@@ -4834,9 +4855,9 @@ definitions:
example: David
x-nullable: true
residentialAddress:
- $ref: 'definitions/Address.yaml'
+ $ref: "definitions/Address.yaml"
backupContact:
- $ref: '#/definitions/BackupContact'
+ $ref: "#/definitions/BackupContact"
id:
type: string
format: uuid
@@ -4862,7 +4883,7 @@ definitions:
pattern: '^[2-9]\d{2}-\d{3}-\d{4}$'
x-nullable: true
backupAddress:
- $ref: 'definitions/Address.yaml'
+ $ref: "definitions/Address.yaml"
cacValidated:
type: boolean
UpdateCustomerPayload:
@@ -4894,9 +4915,9 @@ definitions:
x-nullable: true
current_address:
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
backup_contact:
- $ref: '#/definitions/BackupContact'
+ $ref: "#/definitions/BackupContact"
phoneIsPreferred:
type: boolean
emailIsPreferred:
@@ -4908,22 +4929,22 @@ definitions:
x-nullable: true
backupAddress:
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
cac_validated:
type: boolean
CreateCustomerPayload:
type: object
properties:
affiliation:
- $ref: 'definitions/Affiliation.yaml'
+ $ref: "definitions/Affiliation.yaml"
edipi:
type: string
- example: '1234567890'
+ example: "1234567890"
maxLength: 10
x-nullable: false
emplid:
type: string
- example: '9485155'
+ example: "9485155"
maxLength: 7
x-nullable: true
firstName:
@@ -4961,12 +4982,12 @@ definitions:
type: boolean
residentialAddress:
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
backupContact:
- $ref: '#/definitions/BackupContact'
+ $ref: "#/definitions/BackupContact"
backupMailingAddress:
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
createOktaAccount:
type: boolean
cacUser:
@@ -4975,7 +4996,7 @@ definitions:
type: object
properties:
departmentIndicator:
- $ref: 'definitions/DepartmentIndicator.yaml'
+ $ref: "definitions/DepartmentIndicator.yaml"
effectiveDate:
description: >
The effective date for the Line Of Accounting (LOA) being fetched. Eg, the orders issue date or the Non-Temporary Storage (NTS) Move Task Order (MTO) approval date.
@@ -4986,12 +5007,12 @@ definitions:
users per customer request).
type: string
format: date
- example: '2023-01-01'
+ example: "2023-01-01"
tacCode:
type: string
minLength: 4
maxLength: 4
- example: 'F8J1'
+ example: "F8J1"
SearchCustomersResult:
type: object
properties:
@@ -5002,11 +5023,11 @@ definitions:
totalCount:
type: integer
searchCustomers:
- $ref: '#/definitions/SearchCustomers'
+ $ref: "#/definitions/SearchCustomers"
SearchCustomers:
type: array
items:
- $ref: '#/definitions/SearchCustomer'
+ $ref: "#/definitions/SearchCustomer"
SearchCustomer:
type: object
properties:
@@ -5058,6 +5079,11 @@ definitions:
gunSafe:
type: boolean
example: false
+ weightRestriction:
+ type: integer
+ example: 1500
+ x-formatting: weight
+ x-nullable: true
nonTemporaryStorage:
example: false
type: boolean
@@ -5213,22 +5239,22 @@ definitions:
format: uuid
x-nullable: true
contractor:
- $ref: '#/definitions/Contractor'
+ $ref: "#/definitions/Contractor"
locator:
type: string
- example: '1K43AR'
+ example: "1K43AR"
ordersId:
type: string
format: uuid
example: c56a4180-65aa-42ec-a945-5fd21dec0538
orders:
- $ref: '#/definitions/Order'
+ $ref: "#/definitions/Order"
referenceId:
example: 1001-3456
type: string
x-nullable: true
status:
- $ref: '#/definitions/MoveStatus'
+ $ref: "#/definitions/MoveStatus"
excessUnaccompaniedBaggageWeightQualifiedAt:
type: string
format: date-time
@@ -5265,7 +5291,7 @@ definitions:
x-nullable: true
readOnly: true
closeoutOffice:
- $ref: 'definitions/TransportationOffice.yaml'
+ $ref: "definitions/TransportationOffice.yaml"
closeoutOfficeId:
type: string
format: uuid
@@ -5289,26 +5315,26 @@ definitions:
eTag:
type: string
shipmentGBLOC:
- $ref: '#/definitions/GBLOC'
+ $ref: "#/definitions/GBLOC"
lockedByOfficeUserID:
type: string
format: uuid
x-nullable: true
lockedByOfficeUser:
- $ref: '#/definitions/LockedOfficeUser'
+ $ref: "#/definitions/LockedOfficeUser"
x-nullable: true
lockExpiresAt:
type: string
format: date-time
x-nullable: true
additionalDocuments:
- $ref: 'definitions/Document.yaml'
+ $ref: "definitions/Document.yaml"
SCAssignedUser:
- $ref: '#/definitions/AssignedOfficeUser'
+ $ref: "#/definitions/AssignedOfficeUser"
TOOAssignedUser:
- $ref: '#/definitions/AssignedOfficeUser'
+ $ref: "#/definitions/AssignedOfficeUser"
TIOAssignedUser:
- $ref: '#/definitions/AssignedOfficeUser'
+ $ref: "#/definitions/AssignedOfficeUser"
MoveHistory:
properties:
id:
@@ -5318,11 +5344,11 @@ definitions:
type: string
historyRecords:
description: A list of MoveAuditHistory's connected to the move.
- $ref: '#/definitions/MoveAuditHistories'
+ $ref: "#/definitions/MoveAuditHistories"
locator:
description: move locator
type: string
- example: '1K43AR'
+ example: "1K43AR"
referenceId:
description: move referenceID
example: 1001-3456
@@ -5344,11 +5370,11 @@ definitions:
type: string
historyRecords:
description: A list of MoveAuditHistory's connected to the move.
- $ref: '#/definitions/MoveAuditHistories'
+ $ref: "#/definitions/MoveAuditHistories"
locator:
description: move locator
type: string
- example: '1K43AR'
+ example: "1K43AR"
referenceId:
description: move referenceID
example: 1001-3456
@@ -5357,7 +5383,7 @@ definitions:
MoveAuditHistories:
type: array
items:
- $ref: '#/definitions/MoveAuditHistory'
+ $ref: "#/definitions/MoveAuditHistory"
MoveAuditHistory:
properties:
id:
@@ -5454,7 +5480,7 @@ definitions:
MoveAuditHistoryItems:
type: array
items:
- $ref: '#/definitions/MoveAuditHistoryItem'
+ $ref: "#/definitions/MoveAuditHistoryItem"
MoveAuditHistoryItem:
properties:
columnName:
@@ -5531,10 +5557,10 @@ definitions:
format: uuid
type: string
customer:
- $ref: '#/definitions/Customer'
+ $ref: "#/definitions/Customer"
moveCode:
type: string
- example: 'H2XFJF'
+ example: "H2XFJF"
first_name:
type: string
example: John
@@ -5544,19 +5570,19 @@ definitions:
example: Doe
readOnly: true
grade:
- $ref: '#/definitions/Grade'
+ $ref: "#/definitions/Grade"
agency:
- $ref: 'definitions/Affiliation.yaml'
+ $ref: "definitions/Affiliation.yaml"
entitlement:
- $ref: '#/definitions/Entitlements'
+ $ref: "#/definitions/Entitlements"
destinationDutyLocation:
- $ref: 'definitions/DutyLocation.yaml'
+ $ref: "definitions/DutyLocation.yaml"
destinationDutyLocationGBLOC:
- $ref: '#/definitions/GBLOC'
+ $ref: "#/definitions/GBLOC"
originDutyLocation:
- $ref: 'definitions/DutyLocation.yaml'
+ $ref: "definitions/DutyLocation.yaml"
originDutyLocationGBLOC:
- $ref: '#/definitions/GBLOC'
+ $ref: "#/definitions/GBLOC"
moveTaskOrderID:
example: c56a4180-65aa-42ec-a945-5fd21dec0538
format: uuid
@@ -5577,42 +5603,42 @@ definitions:
order_number:
type: string
x-nullable: true
- example: '030-00362'
+ example: "030-00362"
order_type:
- $ref: 'definitions/OrdersType.yaml'
+ $ref: "definitions/OrdersType.yaml"
order_type_detail:
- $ref: '#/definitions/OrdersTypeDetail'
+ $ref: "#/definitions/OrdersTypeDetail"
x-nullable: true
date_issued:
type: string
format: date
- example: '2020-01-01'
+ example: "2020-01-01"
report_by_date:
type: string
format: date
- example: '2020-01-01'
+ example: "2020-01-01"
department_indicator:
- $ref: '#/definitions/DeptIndicator'
+ $ref: "#/definitions/DeptIndicator"
x-nullable: true
tac:
type: string
title: TAC
- example: 'F8J1'
+ example: "F8J1"
x-nullable: true
sac:
type: string
title: SAC
- example: 'N002214CSW32Y9'
+ example: "N002214CSW32Y9"
x-nullable: true
ntsTac:
type: string
title: NTS TAC
- example: 'F8J1'
+ example: "F8J1"
x-nullable: true
ntsSac:
type: string
title: NTS SAC
- example: 'N002214CSW32Y9'
+ example: "N002214CSW32Y9"
x-nullable: true
has_dependents:
type: boolean
@@ -5631,7 +5657,7 @@ definitions:
naics:
type: string
orders_type:
- $ref: 'definitions/OrdersType.yaml'
+ $ref: "definitions/OrdersType.yaml"
eTag:
type: string
type: object
@@ -5650,7 +5676,7 @@ definitions:
Locations:
type: array
items:
- $ref: '#/definitions/Location'
+ $ref: "#/definitions/Location"
OrderBody:
type: object
properties:
@@ -5675,9 +5701,9 @@ definitions:
format: date
title: Report-by date
ordersType:
- $ref: 'definitions/OrdersType.yaml'
+ $ref: "definitions/OrdersType.yaml"
ordersTypeDetail:
- $ref: '#/definitions/OrdersTypeDetail'
+ $ref: "#/definitions/OrdersTypeDetail"
hasDependents:
type: boolean
title: Are dependents included in your orders?
@@ -5692,21 +5718,21 @@ definitions:
type: string
title: Orders Number
x-nullable: true
- example: '030-00362'
+ example: "030-00362"
tac:
type: string
title: TAC
- example: 'F8J1'
+ example: "F8J1"
x-nullable: true
sac:
type: string
title: SAC
- example: 'N002214CSW32Y9'
+ example: "N002214CSW32Y9"
x-nullable: true
departmentIndicator:
- $ref: '#/definitions/DeptIndicator'
+ $ref: "#/definitions/DeptIndicator"
grade:
- $ref: '#/definitions/Grade'
+ $ref: "#/definitions/Grade"
originDutyLocationId:
type: string
format: uuid
@@ -5741,25 +5767,25 @@ definitions:
type: string
description: The date and time that these orders were cut.
format: date
- example: '2018-04-26'
+ example: "2018-04-26"
title: Orders date
reportByDate:
type: string
description: Report By Date
format: date
- example: '2018-04-26'
+ example: "2018-04-26"
title: Report-by date
ordersType:
- $ref: 'definitions/OrdersType.yaml'
+ $ref: "definitions/OrdersType.yaml"
ordersTypeDetail:
- $ref: '#/definitions/OrdersTypeDetail'
+ $ref: "#/definitions/OrdersTypeDetail"
ordersNumber:
type: string
title: Orders Number
x-nullable: true
- example: '030-00362'
+ example: "030-00362"
departmentIndicator:
- $ref: '#/definitions/DeptIndicator'
+ $ref: "#/definitions/DeptIndicator"
x-nullable: true
originDutyLocationId:
type: string
@@ -5774,21 +5800,21 @@ definitions:
title: HHG TAC
minLength: 4
maxLength: 4
- example: 'F8J1'
+ example: "F8J1"
x-nullable: true
sac:
title: HHG SAC
- example: 'N002214CSW32Y9'
+ example: "N002214CSW32Y9"
$ref: definitions/NullableString.yaml
ntsTac:
title: NTS TAC
minLength: 4
maxLength: 4
- example: 'F8J1'
+ example: "F8J1"
$ref: definitions/NullableString.yaml
ntsSac:
title: NTS SAC
- example: 'N002214CSW32Y9'
+ example: "N002214CSW32Y9"
$ref: definitions/NullableString.yaml
grade:
$ref: '#/definitions/Grade'
@@ -5809,18 +5835,18 @@ definitions:
type: string
description: The date and time that these orders were cut.
format: date
- example: '2018-04-26'
+ example: "2018-04-26"
title: Orders date
reportByDate:
type: string
description: Report By Date
format: date
- example: '2018-04-26'
+ example: "2018-04-26"
title: Report-by date
ordersType:
- $ref: 'definitions/OrdersType.yaml'
+ $ref: "definitions/OrdersType.yaml"
ordersTypeDetail:
- $ref: '#/definitions/OrdersTypeDetail'
+ $ref: "#/definitions/OrdersTypeDetail"
originDutyLocationId:
type: string
format: uuid
@@ -5833,37 +5859,37 @@ definitions:
type: string
title: Orders Number
x-nullable: true
- example: '030-00362'
+ example: "030-00362"
tac:
type: string
title: HHG TAC
minLength: 4
maxLength: 4
- example: 'F8J1'
+ example: "F8J1"
x-nullable: true
sac:
title: HHG SAC
- example: 'N002214CSW32Y9'
+ example: "N002214CSW32Y9"
$ref: definitions/NullableString.yaml
ntsTac:
title: NTS TAC
minLength: 4
maxLength: 4
- example: 'F8J1'
+ example: "F8J1"
$ref: definitions/NullableString.yaml
ntsSac:
title: NTS SAC
- example: 'N002214CSW32Y9'
+ example: "N002214CSW32Y9"
$ref: definitions/NullableString.yaml
departmentIndicator:
- $ref: '#/definitions/DeptIndicator'
+ $ref: "#/definitions/DeptIndicator"
x-nullable: true
ordersAcknowledgement:
description: Confirmation that the new amended orders were reviewed after previously approving the original orders
type: boolean
x-nullable: true
grade:
- $ref: '#/definitions/Grade'
+ $ref: "#/definitions/Grade"
required:
- issueDate
- reportByDate
@@ -5874,12 +5900,12 @@ definitions:
type: object
properties:
grade:
- $ref: '#/definitions/Grade'
+ $ref: "#/definitions/Grade"
dependentsAuthorized:
type: boolean
x-nullable: true
agency:
- $ref: 'definitions/Affiliation.yaml'
+ $ref: "definitions/Affiliation.yaml"
proGearWeight:
description: unit is in lbs
example: 2000
@@ -5933,6 +5959,11 @@ definitions:
example: 500
type: integer
x-nullable: true
+ weightRestriction:
+ example: 1500
+ type: integer
+ x-nullable: true
+ description: Indicates the weight restriction for the move to a particular location.
UpdateBillableWeightPayload:
type: object
properties:
@@ -5966,12 +5997,12 @@ definitions:
type: object
properties:
grade:
- $ref: '#/definitions/Grade'
+ $ref: "#/definitions/Grade"
dependentsAuthorized:
type: boolean
x-nullable: true
agency:
- $ref: 'definitions/Affiliation.yaml'
+ $ref: "definitions/Affiliation.yaml"
proGearWeight:
minimum: 0
maximum: 2000
@@ -6025,6 +6056,11 @@ definitions:
example: 500
type: integer
x-nullable: true
+ weightRestriction:
+ example: 1500
+ type: integer
+ x-nullable: true
+ description: Indicates the weight restriction for a move to a particular location.
MoveTaskOrder:
description: The Move (MoveTaskOrder)
properties:
@@ -6041,7 +6077,7 @@ definitions:
type: string
locator:
type: string
- example: '1K43AR'
+ example: "1K43AR"
referenceId:
example: 1001-3456
type: string
@@ -6061,9 +6097,9 @@ definitions:
format: date-time
type: string
destinationAddress:
- $ref: 'definitions/Address.yaml'
+ $ref: "definitions/Address.yaml"
pickupAddress:
- $ref: 'definitions/Address.yaml'
+ $ref: "definitions/Address.yaml"
destinationDutyLocation:
example: 1f2270c7-7166-40ae-981e-b200ebdf3054
format: uuid
@@ -6073,7 +6109,7 @@ definitions:
format: uuid
type: string
entitlements:
- $ref: '#/definitions/Entitlements'
+ $ref: "#/definitions/Entitlements"
requestedPickupDate:
format: date
type: string
@@ -6086,12 +6122,12 @@ definitions:
type: object
MoveTaskOrders:
items:
- $ref: '#/definitions/MoveTaskOrder'
+ $ref: "#/definitions/MoveTaskOrder"
type: array
PaymentRequest:
properties:
proofOfServiceDocs:
- $ref: '#/definitions/ProofOfServiceDocs'
+ $ref: "#/definitions/ProofOfServiceDocs"
id:
example: c56a4180-65aa-42ec-a945-5fd21dec0538
format: uuid
@@ -6101,7 +6137,7 @@ definitions:
default: false
type: boolean
moveTaskOrder:
- $ref: '#/definitions/Move'
+ $ref: "#/definitions/Move"
moveTaskOrderID:
example: c56a4180-65aa-42ec-a945-5fd21dec0538
format: uuid
@@ -6111,9 +6147,9 @@ definitions:
type: string
x-nullable: true
serviceItems:
- $ref: '#/definitions/PaymentServiceItems'
+ $ref: "#/definitions/PaymentServiceItems"
status:
- $ref: '#/definitions/PaymentRequestStatus'
+ $ref: "#/definitions/PaymentRequestStatus"
paymentRequestNumber:
example: 1234-5678-1
readOnly: true
@@ -6166,11 +6202,11 @@ definitions:
type: object
PaymentRequests:
items:
- $ref: '#/definitions/PaymentRequest'
+ $ref: "#/definitions/PaymentRequest"
type: array
PaymentServiceItems:
items:
- $ref: '#/definitions/PaymentServiceItem'
+ $ref: "#/definitions/PaymentServiceItem"
type: array
PaymentServiceItem:
properties:
@@ -6197,14 +6233,14 @@ definitions:
example: Move management
type: string
mtoShipmentType:
- $ref: 'definitions/MTOShipmentType.yaml'
+ $ref: "definitions/MTOShipmentType.yaml"
mtoShipmentID:
type: string
format: uuid
example: c56a4180-65aa-42ec-a945-5fd21dec0538
x-nullable: true
status:
- $ref: 'definitions/PaymentServiceItemStatus.yaml'
+ $ref: "definitions/PaymentServiceItemStatus.yaml"
priceCents:
type: integer
format: cents
@@ -6219,7 +6255,7 @@ definitions:
readOnly: true
format: string
paymentServiceItemParams:
- $ref: 'definitions/PaymentServiceItemParams.yaml'
+ $ref: "definitions/PaymentServiceItemParams.yaml"
eTag:
type: string
tppsInvoiceAmountPaidPerServiceItemMillicents:
@@ -6229,10 +6265,10 @@ definitions:
x-nullable: true
type: object
PaymentRequestStatus:
- $ref: 'definitions/PaymentRequestStatus.yaml'
+ $ref: "definitions/PaymentRequestStatus.yaml"
ProofOfServiceDocs:
items:
- $ref: '#/definitions/ProofOfServiceDoc'
+ $ref: "#/definitions/ProofOfServiceDoc"
type: array
ProofOfServiceDoc:
properties:
@@ -6240,11 +6276,11 @@ definitions:
type: boolean
uploads:
items:
- $ref: 'definitions/Upload.yaml'
+ $ref: "definitions/Upload.yaml"
type: array
ShipmentsPaymentSITBalance:
items:
- $ref: '#/definitions/ShipmentPaymentSITBalance'
+ $ref: "#/definitions/ShipmentPaymentSITBalance"
type: array
ShipmentPaymentSITBalance:
properties:
@@ -6284,7 +6320,7 @@ definitions:
type: object
properties:
shipmentType:
- $ref: 'definitions/MTOShipmentType.yaml'
+ $ref: "definitions/MTOShipmentType.yaml"
requestedPickupDate:
format: date
type: string
@@ -6313,16 +6349,16 @@ definitions:
x-nullable: true
pickupAddress:
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
destinationAddress:
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
secondaryDeliveryAddress:
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
secondaryPickupAddress:
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
hasSecondaryPickupAddress:
type: boolean
x-nullable: true
@@ -6333,10 +6369,10 @@ definitions:
x-omitempty: false
tertiaryDeliveryAddress:
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
tertiaryPickupAddress:
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
hasTertiaryPickupAddress:
type: boolean
x-nullable: true
@@ -6354,14 +6390,14 @@ definitions:
x-nullable: true
x-omitempty: false
destinationType:
- $ref: 'definitions/DestinationType.yaml'
+ $ref: "definitions/DestinationType.yaml"
agents:
- $ref: 'definitions/MTOAgents.yaml'
+ $ref: "definitions/MTOAgents.yaml"
x-nullable: true
tacType:
- $ref: 'definitions/LOATypeNullable.yaml'
+ $ref: "definitions/LOATypeNullable.yaml"
sacType:
- $ref: 'definitions/LOATypeNullable.yaml'
+ $ref: "definitions/LOATypeNullable.yaml"
usesExternalVendor:
type: boolean
example: false
@@ -6377,13 +6413,13 @@ definitions:
x-nullable: true
storageFacility:
x-nullable: true
- $ref: 'definitions/StorageFacility.yaml'
+ $ref: "definitions/StorageFacility.yaml"
ppmShipment:
- $ref: '#/definitions/UpdatePPMShipment'
+ $ref: "#/definitions/UpdatePPMShipment"
boatShipment:
- $ref: '#/definitions/UpdateBoatShipment'
+ $ref: "#/definitions/UpdateBoatShipment"
mobileHomeShipment:
- $ref: '#/definitions/UpdateMobileHomeShipment'
+ $ref: "#/definitions/UpdateMobileHomeShipment"
UpdatePPMShipment:
type: object
properties:
@@ -6399,34 +6435,34 @@ definitions:
x-nullable: true
pickupAddress:
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
actualPickupPostalCode:
description: >
The actual postal code where the PPM shipment started. To be filled once the customer has moved the shipment.
format: zip
type: string
title: ZIP
- example: '90210'
+ example: "90210"
pattern: ^(\d{5})$
x-nullable: true
secondaryPickupAddress:
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
destinationAddress:
allOf:
- - $ref: 'definitions/PPMDestinationAddress.yaml'
+ - $ref: "definitions/PPMDestinationAddress.yaml"
actualDestinationPostalCode:
description: >
The actual postal code where the PPM shipment ended. To be filled once the customer has moved the shipment.
format: zip
type: string
title: ZIP
- example: '90210'
+ example: "90210"
pattern: ^(\d{5})$
x-nullable: true
secondaryDestinationAddress:
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
hasSecondaryPickupAddress:
type: boolean
x-nullable: true
@@ -6437,10 +6473,10 @@ definitions:
x-omitempty: false
tertiaryPickupAddress:
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
tertiaryDestinationAddress:
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
hasTertiaryPickupAddress:
type: boolean
x-nullable: true
@@ -6451,13 +6487,13 @@ definitions:
x-omitempty: false
w2Address:
x-nullable: true
- $ref: 'definitions/Address.yaml'
+ $ref: "definitions/Address.yaml"
sitExpected:
type: boolean
x-nullable: true
sitLocation:
allOf:
- - $ref: 'definitions/SITLocationType.yaml'
+ - $ref: "definitions/SITLocationType.yaml"
- x-nullable: true
sitEstimatedWeight:
type: integer
@@ -6515,7 +6551,7 @@ definitions:
format: cents
x-nullable: true
advanceStatus:
- $ref: 'definitions/PPMAdvanceStatus.yaml'
+ $ref: "definitions/PPMAdvanceStatus.yaml"
x-nullable: true
isActualExpenseReimbursement:
description: Used for PPM shipments only. Denotes if this shipment uses the Actual Expense Reimbursement method.
@@ -6609,7 +6645,7 @@ definitions:
description: Indicates if the trailer that the customer used meets all the criteria to be claimable.
type: boolean
status:
- $ref: 'definitions/PPMDocumentStatus.yaml'
+ $ref: "definitions/PPMDocumentStatus.yaml"
reason:
description: The reason the services counselor has excluded or rejected the item.
type: string
@@ -6624,7 +6660,7 @@ definitions:
type: object
properties:
movingExpenseType:
- $ref: 'definitions/OmittableMovingExpenseType.yaml'
+ $ref: "definitions/OmittableMovingExpenseType.yaml"
description:
description: A brief description of the expense.
type: string
@@ -6642,7 +6678,7 @@ definitions:
type: string
format: date
status:
- $ref: 'definitions/PPMDocumentStatus.yaml'
+ $ref: "definitions/PPMDocumentStatus.yaml"
reason:
description: The reason the services counselor has excluded or rejected the item.
type: string
@@ -6651,7 +6687,7 @@ definitions:
type: integer
sitLocation:
allOf:
- - $ref: 'definitions/SITLocationType.yaml'
+ - $ref: "definitions/SITLocationType.yaml"
- x-nullable: true
sitEstimatedCost:
description: The estimated amount that the government will pay the service member to put their goods into storage. This estimated storage cost is separate from the estimated incentive.
@@ -6679,7 +6715,7 @@ definitions:
type: integer
minimum: 0
status:
- $ref: 'definitions/PPMDocumentStatus.yaml'
+ $ref: "definitions/PPMDocumentStatus.yaml"
reason:
description: The reason the services counselor has excluded or rejected the item.
type: string
@@ -6703,7 +6739,7 @@ definitions:
- approveShipments
MTOShipments:
items:
- $ref: 'definitions/MTOShipment.yaml'
+ $ref: "definitions/MTOShipment.yaml"
type: array
CreateMTOShipment:
type: object
@@ -6749,17 +6785,17 @@ definitions:
example: handle with care
x-nullable: true
agents:
- $ref: 'definitions/MTOAgents.yaml'
+ $ref: "definitions/MTOAgents.yaml"
mtoServiceItems:
- $ref: 'definitions/MTOServiceItems.yaml'
+ $ref: "definitions/MTOServiceItems.yaml"
pickupAddress:
description: The address where the movers should pick up this shipment.
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
destinationAddress:
description: Where the movers should deliver this shipment.
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
hasSecondaryPickupAddress:
type: boolean
x-nullable: true
@@ -6767,7 +6803,7 @@ definitions:
secondaryPickupAddress:
description: The address where the movers should pick up this shipment.
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
hasSecondaryDeliveryAddress:
type: boolean
x-nullable: true
@@ -6775,7 +6811,7 @@ definitions:
secondaryDeliveryAddress:
description: Where the movers should deliver this shipment.
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
hasTertiaryPickupAddress:
type: boolean
x-nullable: true
@@ -6783,7 +6819,7 @@ definitions:
tertiaryPickupAddress:
description: The address where the movers should pick up this shipment.
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
hasTertiaryDeliveryAddress:
type: boolean
x-nullable: true
@@ -6791,18 +6827,18 @@ definitions:
tertiaryDeliveryAddress:
description: Where the movers should deliver this shipment.
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
destinationType:
- $ref: 'definitions/DestinationType.yaml'
+ $ref: "definitions/DestinationType.yaml"
shipmentType:
- $ref: 'definitions/MTOShipmentType.yaml'
+ $ref: "definitions/MTOShipmentType.yaml"
tacType:
allOf:
- - $ref: 'definitions/LOAType.yaml'
+ - $ref: "definitions/LOAType.yaml"
- x-nullable: true
sacType:
allOf:
- - $ref: 'definitions/LOAType.yaml'
+ - $ref: "definitions/LOAType.yaml"
- x-nullable: true
usesExternalVendor:
type: boolean
@@ -6819,13 +6855,13 @@ definitions:
x-formatting: weight
storageFacility:
x-nullable: true
- $ref: 'definitions/StorageFacility.yaml'
+ $ref: "definitions/StorageFacility.yaml"
mobileHomeShipment:
- $ref: '#/definitions/CreateMobileHomeShipment'
+ $ref: "#/definitions/CreateMobileHomeShipment"
ppmShipment:
- $ref: '#/definitions/CreatePPMShipment'
+ $ref: "#/definitions/CreatePPMShipment"
boatShipment:
- $ref: '#/definitions/CreateBoatShipment'
+ $ref: "#/definitions/CreateBoatShipment"
required:
- moveTaskOrderID
- shipmentType
@@ -6839,22 +6875,22 @@ definitions:
type: string
pickupAddress:
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
secondaryPickupAddress:
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
tertiaryPickupAddress:
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
destinationAddress:
allOf:
- - $ref: 'definitions/PPMDestinationAddress.yaml'
+ - $ref: "definitions/PPMDestinationAddress.yaml"
secondaryDestinationAddress:
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
tertiaryDestinationAddress:
allOf:
- - $ref: 'definitions/Address.yaml'
+ - $ref: "definitions/Address.yaml"
hasSecondaryPickupAddress:
type: boolean
x-nullable: true
@@ -6875,7 +6911,7 @@ definitions:
type: boolean
sitLocation:
allOf:
- - $ref: 'definitions/SITLocationType.yaml'
+ - $ref: "definitions/SITLocationType.yaml"
- x-nullable: true
sitEstimatedWeight:
type: integer
@@ -7008,7 +7044,7 @@ definitions:
minimum: 1
requestReason:
description: Reason from service counselor-provided picklist for SIT Duration Update
- example: 'AWAITING_COMPLETION_OF_RESIDENCE'
+ example: "AWAITING_COMPLETION_OF_RESIDENCE"
type: string
enum:
- SERIOUS_ILLNESS_MEMBER
@@ -7055,7 +7091,7 @@ definitions:
properties:
requestReason:
description: Reason from service counselor-provided picklist for SIT Duration Update
- example: 'AWAITING_COMPLETION_OF_RESIDENCE'
+ example: "AWAITING_COMPLETION_OF_RESIDENCE"
type: string
enum:
- SERIOUS_ILLNESS_MEMBER
@@ -7116,14 +7152,14 @@ definitions:
type: string
x-nullable: true
status:
- $ref: '#/definitions/PaymentRequestStatus'
+ $ref: "#/definitions/PaymentRequestStatus"
eTag:
type: string
type: object
BulkAssignmentMoveIDs:
type: array
items:
- $ref: '#/definitions/BulkAssignmentMoveID'
+ $ref: "#/definitions/BulkAssignmentMoveID"
BulkAssignmentMoveID:
type: string
format: uuid
@@ -7131,7 +7167,7 @@ definitions:
AvailableOfficeUsers:
type: array
items:
- $ref: '#/definitions/AvailableOfficeUser'
+ $ref: "#/definitions/AvailableOfficeUser"
AvailableOfficeUser:
type: object
properties:
@@ -7152,13 +7188,13 @@ definitions:
type: object
properties:
availableOfficeUsers:
- $ref: '#/definitions/AvailableOfficeUsers'
+ $ref: "#/definitions/AvailableOfficeUsers"
bulkAssignmentMoveIDs:
- $ref: '#/definitions/BulkAssignmentMoveIDs'
+ $ref: "#/definitions/BulkAssignmentMoveIDs"
QueueMoves:
type: array
items:
- $ref: '#/definitions/QueueMove'
+ $ref: "#/definitions/QueueMove"
QueueMove:
type: object
properties:
@@ -7166,9 +7202,9 @@ definitions:
type: string
format: uuid
customer:
- $ref: '#/definitions/Customer'
+ $ref: "#/definitions/Customer"
status:
- $ref: '#/definitions/MoveStatus'
+ $ref: "#/definitions/MoveStatus"
locator:
type: string
submittedAt:
@@ -7184,15 +7220,15 @@ definitions:
type: string
x-nullable: true
departmentIndicator:
- $ref: '#/definitions/DeptIndicator'
+ $ref: "#/definitions/DeptIndicator"
shipmentsCount:
type: integer
originDutyLocation:
- $ref: 'definitions/DutyLocation.yaml'
+ $ref: "definitions/DutyLocation.yaml"
destinationDutyLocation:
- $ref: 'definitions/DutyLocation.yaml'
+ $ref: "definitions/DutyLocation.yaml"
originGBLOC:
- $ref: '#/definitions/GBLOC'
+ $ref: "#/definitions/GBLOC"
ppmType:
type: string
enum: [FULL, PARTIAL]
@@ -7212,14 +7248,14 @@ definitions:
format: uuid
x-nullable: true
lockedByOfficeUser:
- $ref: '#/definitions/LockedOfficeUser'
+ $ref: "#/definitions/LockedOfficeUser"
x-nullable: true
lockExpiresAt:
type: string
format: date-time
x-nullable: true
ppmStatus:
- $ref: '#/definitions/PPMStatus'
+ $ref: "#/definitions/PPMStatus"
x-nullable: true
counselingOffice:
type: string
@@ -7229,10 +7265,10 @@ definitions:
format: uuid
x-nullable: true
assignedTo:
- $ref: '#/definitions/AssignedOfficeUser'
+ $ref: "#/definitions/AssignedOfficeUser"
x-nullable: true
availableOfficeUsers:
- $ref: '#/definitions/AvailableOfficeUsers'
+ $ref: "#/definitions/AvailableOfficeUsers"
assignable:
type: boolean
QueueMovesResult:
@@ -7245,7 +7281,7 @@ definitions:
totalCount:
type: integer
queueMoves:
- $ref: '#/definitions/QueueMoves'
+ $ref: "#/definitions/QueueMoves"
ListPrimeMove:
description: >
An abbreviated definition for a move, without all the nested information (shipments, service items, etc). Used to
@@ -7258,7 +7294,7 @@ definitions:
type: string
moveCode:
type: string
- example: 'HYXFJF'
+ example: "HYXFJF"
readOnly: true
createdAt:
format: date-time
@@ -7304,7 +7340,7 @@ definitions:
ListPrimeMoves:
type: array
items:
- $ref: '#/definitions/ListPrimeMove'
+ $ref: "#/definitions/ListPrimeMove"
ListPrimeMovesResult:
type: object
properties:
@@ -7315,7 +7351,7 @@ definitions:
totalCount:
type: integer
queueMoves:
- $ref: '#/definitions/ListPrimeMoves'
+ $ref: "#/definitions/ListPrimeMoves"
QueuePaymentRequest:
type: object
properties:
@@ -7326,9 +7362,9 @@ definitions:
type: string
format: uuid
customer:
- $ref: '#/definitions/Customer'
+ $ref: "#/definitions/Customer"
status:
- $ref: '#/definitions/QueuePaymentRequestStatus'
+ $ref: "#/definitions/QueuePaymentRequestStatus"
age:
type: number
format: double
@@ -7339,11 +7375,11 @@ definitions:
locator:
type: string
departmentIndicator:
- $ref: '#/definitions/DeptIndicator'
+ $ref: "#/definitions/DeptIndicator"
originGBLOC:
- $ref: '#/definitions/GBLOC'
+ $ref: "#/definitions/GBLOC"
originDutyLocation:
- $ref: 'definitions/DutyLocation.yaml'
+ $ref: "definitions/DutyLocation.yaml"
orderType:
type: string
x-nullable: true
@@ -7356,10 +7392,10 @@ definitions:
format: date-time
x-nullable: true
assignedTo:
- $ref: '#/definitions/AssignedOfficeUser'
+ $ref: "#/definitions/AssignedOfficeUser"
x-nullable: true
availableOfficeUsers:
- $ref: '#/definitions/AvailableOfficeUsers'
+ $ref: "#/definitions/AvailableOfficeUsers"
assignable:
type: boolean
counselingOffice:
@@ -7368,7 +7404,7 @@ definitions:
QueuePaymentRequests:
type: array
items:
- $ref: '#/definitions/QueuePaymentRequest'
+ $ref: "#/definitions/QueuePaymentRequest"
QueuePaymentRequestsResult:
type: object
properties:
@@ -7379,7 +7415,7 @@ definitions:
totalCount:
type: integer
queuePaymentRequests:
- $ref: '#/definitions/QueuePaymentRequests'
+ $ref: "#/definitions/QueuePaymentRequests"
QueuePaymentRequestStatus:
enum:
- Payment requested
@@ -7391,7 +7427,7 @@ definitions:
SearchMoves:
type: array
items:
- $ref: '#/definitions/SearchMove'
+ $ref: "#/definitions/SearchMove"
SearchMove:
type: object
properties:
@@ -7415,7 +7451,7 @@ definitions:
example: 9551-6199-2
x-nullable: true
status:
- $ref: '#/definitions/MoveStatus'
+ $ref: "#/definitions/MoveStatus"
locator:
type: string
branch:
@@ -7426,13 +7462,13 @@ definitions:
format: zip
type: string
title: ZIP
- example: '90210'
+ example: "90210"
pattern: ^(\d{5})$
destinationPostalCode:
format: zip
type: string
title: ZIP
- example: '90210'
+ example: "90210"
pattern: ^(\d{5})$
requestedPickupDate:
type: string
@@ -7445,9 +7481,9 @@ definitions:
format: date
x-nullable: true
originGBLOC:
- $ref: '#/definitions/GBLOC'
+ $ref: "#/definitions/GBLOC"
destinationGBLOC:
- $ref: '#/definitions/GBLOC'
+ $ref: "#/definitions/GBLOC"
lockedByOfficeUserID:
type: string
format: uuid
@@ -7469,7 +7505,7 @@ definitions:
totalCount:
type: integer
searchMoves:
- $ref: '#/definitions/SearchMoves'
+ $ref: "#/definitions/SearchMoves"
GBLOC:
type: string
enum:
@@ -7564,7 +7600,7 @@ definitions:
EvaluationReportList:
type: array
items:
- $ref: '#/definitions/EvaluationReport'
+ $ref: "#/definitions/EvaluationReport"
EvaluationReport:
type: object
description: An evaluation report
@@ -7586,28 +7622,28 @@ definitions:
x-nullable: true
readOnly: true
type:
- $ref: '#/definitions/EvaluationReportType'
+ $ref: "#/definitions/EvaluationReportType"
inspectionType:
- $ref: '#/definitions/EvaluationReportInspectionType'
+ $ref: "#/definitions/EvaluationReportInspectionType"
x-nullable: true
inspectionDate:
type: string
format: date
x-nullable: true
officeUser:
- $ref: '#/definitions/EvaluationReportOfficeUser'
+ $ref: "#/definitions/EvaluationReportOfficeUser"
location:
- $ref: '#/definitions/EvaluationReportLocation'
+ $ref: "#/definitions/EvaluationReportLocation"
x-nullable: true
reportViolations:
- $ref: '#/definitions/ReportViolations'
+ $ref: "#/definitions/ReportViolations"
x-nullable: true
gsrAppeals:
- $ref: '#/definitions/GSRAppeals'
+ $ref: "#/definitions/GSRAppeals"
x-nullable: true
locationDescription:
type: string
- example: 'Route 66 at crash inspection site 3'
+ example: "Route 66 at crash inspection site 3"
x-nullable: true
observedShipmentDeliveryDate:
type: string
@@ -7620,18 +7656,18 @@ definitions:
timeDepart:
type: string
x-nullable: true
- pattern: '^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$'
- example: '14:30'
+ pattern: "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$"
+ example: "14:30"
evalStart:
type: string
x-nullable: true
- pattern: '^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$'
- example: '15:00'
+ pattern: "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$"
+ example: "15:00"
evalEnd:
type: string
x-nullable: true
- pattern: '^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$'
- example: '18:00'
+ pattern: "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$"
+ example: "18:00"
violationsObserved:
type: boolean
x-nullable: true
@@ -7743,7 +7779,7 @@ definitions:
PWSViolations:
type: array
items:
- $ref: '#/definitions/PWSViolation'
+ $ref: "#/definitions/PWSViolation"
AssociateReportViolations:
type: object
description: A list of PWS violation string ids to associate with an evaluation report
@@ -7770,14 +7806,14 @@ definitions:
format: uuid
type: string
violation:
- $ref: '#/definitions/PWSViolation'
+ $ref: "#/definitions/PWSViolation"
gsrAppeals:
- $ref: '#/definitions/GSRAppeals'
+ $ref: "#/definitions/GSRAppeals"
x-nullable: true
ReportViolations:
type: array
items:
- $ref: '#/definitions/ReportViolation'
+ $ref: "#/definitions/ReportViolation"
GSRAppealStatusType:
type: string
enum:
@@ -7786,7 +7822,7 @@ definitions:
GSRAppeals:
type: array
items:
- $ref: '#/definitions/GSRAppeal'
+ $ref: "#/definitions/GSRAppeal"
GSRAppeal:
type: object
description: An object associating appeals on violations and serious incidents
@@ -7808,12 +7844,12 @@ definitions:
format: uuid
type: string
officeUser:
- $ref: '#/definitions/EvaluationReportOfficeUser'
+ $ref: "#/definitions/EvaluationReportOfficeUser"
isSeriousIncident:
type: boolean
example: false
appealStatus:
- $ref: '#/definitions/GSRAppealStatusType'
+ $ref: "#/definitions/GSRAppealStatusType"
remarks:
type: string
example: Office user remarks
@@ -7824,7 +7860,7 @@ definitions:
TransportationOffices:
type: array
items:
- $ref: 'definitions/TransportationOffice.yaml'
+ $ref: "definitions/TransportationOffice.yaml"
VLocations:
type: array
items:
@@ -7855,9 +7891,9 @@ definitions:
readOnly: true
locator:
type: string
- example: '12432'
+ example: "12432"
status:
- $ref: '#/definitions/MoveStatus'
+ $ref: "#/definitions/MoveStatus"
created_at:
type: string
format: date-time
@@ -7869,9 +7905,9 @@ definitions:
format: date-time
x-nullable: true
mto_shipments:
- $ref: '#/definitions/MTOShipments'
+ $ref: "#/definitions/MTOShipments"
closeout_office:
- $ref: '#/definitions/TransportationOffice'
+ $ref: "#/definitions/TransportationOffice"
cancel_reason:
type: string
example: Change of orders
@@ -7883,7 +7919,7 @@ definitions:
type: string
readOnly: true
additionalDocuments:
- $ref: 'definitions/Document.yaml'
+ $ref: "definitions/Document.yaml"
required:
- id
- orders_id
@@ -7901,7 +7937,7 @@ definitions:
date:
type: string
format: date
- example: '2018-09-25'
+ example: "2018-09-25"
is_weekend:
type: boolean
is_holiday:
@@ -7940,28 +7976,28 @@ responses:
InvalidRequest:
description: The request payload is invalid
schema:
- $ref: '#/definitions/Error'
+ $ref: "#/definitions/Error"
NotFound:
description: The requested resource wasn't found
schema:
- $ref: '#/definitions/Error'
+ $ref: "#/definitions/Error"
Conflict:
description: Conflict error
schema:
- $ref: '#/definitions/Error'
+ $ref: "#/definitions/Error"
PermissionDenied:
description: The request was denied
schema:
- $ref: '#/definitions/Error'
+ $ref: "#/definitions/Error"
ServerError:
description: A server error occurred
schema:
- $ref: '#/definitions/Error'
+ $ref: "#/definitions/Error"
PreconditionFailed:
description: Precondition failed
schema:
- $ref: '#/definitions/Error'
+ $ref: "#/definitions/Error"
UnprocessableEntity:
description: The payload was unprocessable.
schema:
- $ref: '#/definitions/ValidationError'
+ $ref: "#/definitions/ValidationError"
diff --git a/swagger-def/support.yaml b/swagger-def/support.yaml
index 77d18b9e6af..b1b34351e9a 100644
--- a/swagger-def/support.yaml
+++ b/swagger-def/support.yaml
@@ -878,6 +878,10 @@ definitions:
gunSafe:
type: boolean
example: false
+ weightRestriction:
+ example: 1500
+ type: integer
+ x-nullable: true
nonTemporaryStorage:
example: false
type: boolean
diff --git a/swagger/ghc.yaml b/swagger/ghc.yaml
index 5b53cc0462e..0cf3ff25f82 100644
--- a/swagger/ghc.yaml
+++ b/swagger/ghc.yaml
@@ -5283,6 +5283,11 @@ definitions:
gunSafe:
type: boolean
example: false
+ weightRestriction:
+ type: integer
+ example: 1500
+ x-formatting: weight
+ x-nullable: true
nonTemporaryStorage:
example: false
type: boolean
@@ -6214,6 +6219,13 @@ definitions:
example: 500
type: integer
x-nullable: true
+ weightRestriction:
+ example: 1500
+ type: integer
+ x-nullable: true
+ description: >-
+ Indicates the weight restriction for the move to a particular
+ location.
UpdateBillableWeightPayload:
type: object
properties:
@@ -6317,6 +6329,11 @@ definitions:
example: 500
type: integer
x-nullable: true
+ weightRestriction:
+ example: 1500
+ type: integer
+ x-nullable: true
+ description: Indicates the weight restriction for a move to a particular location.
MoveTaskOrder:
description: The Move (MoveTaskOrder)
properties:
diff --git a/swagger/prime.yaml b/swagger/prime.yaml
index e183ef0aa0d..19cecc3266e 100644
--- a/swagger/prime.yaml
+++ b/swagger/prime.yaml
@@ -3426,6 +3426,11 @@ definitions:
totalDependents:
example: 2
type: integer
+ weightRestriction:
+ example: 1500
+ type: integer
+ x-formatting: weight
+ x-nullable: true
eTag:
type: string
readOnly: true
diff --git a/swagger/prime_v2.yaml b/swagger/prime_v2.yaml
index 522a9c3157b..d5d7a41b687 100644
--- a/swagger/prime_v2.yaml
+++ b/swagger/prime_v2.yaml
@@ -1779,6 +1779,11 @@ definitions:
totalDependents:
example: 2
type: integer
+ weightRestriction:
+ example: 1500
+ type: integer
+ x-formatting: weight
+ x-nullable: true
eTag:
type: string
readOnly: true
diff --git a/swagger/prime_v3.yaml b/swagger/prime_v3.yaml
index d06c237667d..cd2473feb5f 100644
--- a/swagger/prime_v3.yaml
+++ b/swagger/prime_v3.yaml
@@ -1886,6 +1886,11 @@ definitions:
totalDependents:
example: 2
type: integer
+ weightRestriction:
+ example: 1500
+ type: integer
+ x-formatting: weight
+ x-nullable: true
eTag:
type: string
readOnly: true
diff --git a/swagger/support.yaml b/swagger/support.yaml
index f663ea33d09..362742d57a9 100644
--- a/swagger/support.yaml
+++ b/swagger/support.yaml
@@ -953,6 +953,10 @@ definitions:
gunSafe:
type: boolean
example: false
+ weightRestriction:
+ example: 1500
+ type: integer
+ x-nullable: true
nonTemporaryStorage:
example: false
type: boolean