Get RMIS Carrier Compliance policy settings

Authorizations:

Responses

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_certified
required
string (CarrierStatus)
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
certification_status_not_certified
required
string (CarrierStatus)
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
certification_status_unknown
required
string (CarrierStatus)
Enum: "ACTIVE" "INACTIVE" "DO_NOT_USE"
company
string <uuid>
id
string <uuid>
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"
real_time_sync
required
boolean
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"

Request samples

curl -i -X GET \
  'https://{host}{basePath}/carrier-compliance/integrations/rmis/policy/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "cargo_insurance_amount_policy": "ACTIVE",
  • "cargo_insurance_amount_threshold": 0,
  • "cargo_insurance_expiration_policy": "ACTIVE",
  • "cargo_insurance_expiration_threshold": 0,
  • "certification_status_certified": "ACTIVE",
  • "certification_status_not_certified": "ACTIVE",
  • "certification_status_unknown": "ACTIVE",
  • "company": "87340f10-f684-4b06-8427-5981380bd9a9",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "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",
  • "real_time_sync": true,
  • "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 2020. All right reserved.