Carrier


Hours of Service (HOS) web service for Carrier data

The following operations are supported. For a formal definition, please review the Service Description.

  • Add
    Add Carrier with carrierData.
    • Name is a required filed that may not be either empty strings or null.
    If any other request fields are null, corresponding Carrier table fields will be set to null.
    If a request field value is an empty string, corresponding field in the database will be updated with it.
    Name must be unique for a given NMCAccount. If this constraint is violated, SOAP fault "System.Web.Services.Protocols.SoapException: Record already exists." will result.
  • Get
    Returns a CarrierInfo object that contains the properties for the carrier corresponding to the specified carrier name.
  • GetCarriers
    Returns a list of CarrierInfo objects for the carriers in the company.
  • Update
    Update oldCarrier with newCarrier data. oldCarrier is found based on Name specified in oldCarrier and on NMCAccount derived from the user login credentials. Only oldCarrier/Name field is used. Other oldCarrier fields are ignored.
    • Name is a required filed in both oldCarrier and newCarrier. It may not be either an empty string or null.
    If any other request fields are null, corresponding Carrier table fields will not be changed.
    If a request field value is an empty string, database will be updated with it.
    If there is no record with a given NMCAccount and Name, SOAP fault "System.Web.Services.Protocols.SoapException: Carrier with name '[Name]' does not exist." will result.
    When updating Name keep in mind that it must be unique for a given NMCAccount. If this constraint is violated, SOAP fault "System.Web.Services.Protocols.SoapException: Record already exists." will result.
  • VerifyAccess
    Provided as a convenience to determine if the caller has access to the web service.