Get SaferWatch Carrier Compliance policy settings

Request
Security:
Responses
200

Successfully returned a company's SaferWatch Carrier Policy.

Response Schema: application/json
cargo_insurance_amount_policy
required
string (CarrierStatus)
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
cargo_insurance_amount_threshold
required
integer <int32>
cargo_insurance_expiration_policy
required
string (CarrierStatus)
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
cargo_insurance_expiration_threshold
required
integer <int32>
certification_status_acceptable
required
string (CarrierStatus)
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
certification_status_moderate
required
string (CarrierStatus)
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
certification_status_unacceptable
required
string (CarrierStatus)
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
company_id
string or null
insurance_rating_policy
required
string (CarrierStatus)
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
insurance_rating_threshold
required
string
insurance_status_active
required
string (CarrierStatus)
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
insurance_status_inactive
required
string (CarrierStatus)
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
operating_authority_status_active
required
string (CarrierStatus)
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
operating_authority_status_authorized
required
string (CarrierStatus)
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
operating_authority_status_inactive
required
string (CarrierStatus)
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
operating_authority_status_not_authorized
required
string (CarrierStatus)
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
operating_authority_status_out_of_service
required
string (CarrierStatus)
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
safety_rating_date_policy
required
string (CarrierStatus)
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
safety_rating_date_threshold
required
integer <int32>
safety_rating_status_conditional
required
string (CarrierStatus)
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
safety_rating_status_non_satisfactory
required
string (CarrierStatus)
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
safety_rating_status_satisfactory
required
string (CarrierStatus)
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
safety_rating_status_unrated
required
string (CarrierStatus)
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
default

Default error response

get/carrier-compliance/integrations/saferwatch/policy/
Request samples
curl -i -X GET \
  https://dev-api.shipwell.com/v2/carrier-compliance/integrations/saferwatch/policy/ \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "cargo_insurance_amount_policy": "ACTIVE",
  • "cargo_insurance_amount_threshold": 0,
  • "cargo_insurance_expiration_policy": "ACTIVE",
  • "cargo_insurance_expiration_threshold": 0,
  • "certification_status_acceptable": "ACTIVE",
  • "certification_status_moderate": "ACTIVE",
  • "certification_status_unacceptable": "ACTIVE",
  • "company_id": "string",
  • "insurance_rating_policy": "ACTIVE",
  • "insurance_rating_threshold": "string",
  • "insurance_status_active": "ACTIVE",
  • "insurance_status_inactive": "ACTIVE",
  • "operating_authority_status_active": "ACTIVE",
  • "operating_authority_status_authorized": "ACTIVE",
  • "operating_authority_status_inactive": "ACTIVE",
  • "operating_authority_status_not_authorized": "ACTIVE",
  • "operating_authority_status_out_of_service": "ACTIVE",
  • "safety_rating_date_policy": "ACTIVE",
  • "safety_rating_date_threshold": 0,
  • "safety_rating_status_conditional": "ACTIVE",
  • "safety_rating_status_non_satisfactory": "ACTIVE",
  • "safety_rating_status_satisfactory": "ACTIVE",
  • "safety_rating_status_unrated": "ACTIVE"
}
Copyright © Shipwell 2022. All right reserved.