Carrier
Hours of Service (HOS) web service for Carrier data
- Definitions
null
fields are the fields that are either omitted or initialized to a special value -string "NULL"
.- E.g., <Street1>NULL<Street1/> will be interpreted as a
null
field. - Empty
string
fields are, e.g., <Street1 /> or <Street2></Street2>
The following operations are supported. For a formal definition, please review the Service Description.
-
Add
Add Carrier withcarrierData
.Name
is a required filed that may not be either empty strings ornull
.
null
, corresponding Carrier table fields will be set tonull
.
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 givenNMCAccount
. 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
UpdateoldCarrier
withnewCarrier
data.oldCarrier
is found based onName
specified inoldCarrier
and onNMCAccount
derived from the user login credentials. OnlyoldCarrier/Name
field is used. OtheroldCarrier
fields are ignored.Name
is a required filed in botholdCarrier
andnewCarrier
. It may not be either an empty string ornull
.
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 givenNMCAccount
andName
, SOAP fault "System.Web.Services.Protocols.SoapException: Carrier with name '[Name]' does not exist.
" will result.
When updatingName
keep in mind that it must be unique for a givenNMCAccount
. 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.