Performs batched add, update, and remove operations against the authenticated broker's network. Carriers are identified by DOT number only.
The request is an array of operation groups; each group specifies an action and the DOT numbers it applies to. The response mirrors that structure and, for each operation group, reports the DOT numbers that were affected as well as the DOT numbers that were skipped along with a per-item reason and code.
Each operation result reports DOT numbers in three buckets: affected (the action was performed exactly as requested), adjusted (the action was performed but altered from what was requested - for example, an Add that would exceed the broker's active-network limit is added to the inactive list instead), and skipped (the action was not performed; reason explains why).
Semantics:
- Add - affected are DOT numbers that were not already in the network and
have been added to the active list when
activateis true or to the inactive list whenactivateis false. Adjusted are DOT numbers that were added but placed differently than requested - currently, this occurs when adding withactivatetrue would exceed the broker's active-network limit, in which case the overflow DOTs are added to the inactive list and reported here with reasonOverLimitAddedInactive. Skipped are DOT numbers already in the network (AddDuplicate), invalid (InvalidDot), or otherwise not added (Other).activateis required. - Update - affected are DOT numbers that were in the network and now
appear on the active list when
activateis true or on the inactive list whenactivateis false. A carrier already on the target list is still considered affected. Skipped are DOT numbers not in the network (UpdateNotFound), invalid (InvalidDot), or otherwise not updated (Other).activateis required. - Remove - affected are DOT numbers that were in the network and have
been removed from it entirely (no longer on either list). Skipped are
DOT numbers not in the network (RemoveNotFound), invalid (InvalidDot),
or otherwise not removed (Other).
activatemust be omitted or null; supplying a value results in a 400 response.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||