POST BridgeCoordinator/BridgeToCarrier

Request Information

URI Parameters

None.

Body Parameters

BridgeRequest
NameDescriptionTypeAdditional information
SavedRateId

globally unique identifier

None.

BridgeProcessId

globally unique identifier

None.

MethodPaymentCd

string

None.

PaymentPlanCd

string

None.

Term

string

None.

PreferredDriveLetter

string

None.

Request Formats

application/json, text/json

Sample:
{
  "SavedRateId": "d0f3c4b5-ca2d-48d2-abd0-45e65cf62aad",
  "BridgeProcessId": "1a6687b8-b403-43a5-8fc7-248d9ed2f114",
  "MethodPaymentCd": "sample string 3",
  "PaymentPlanCd": "sample string 4",
  "Term": "sample string 5",
  "PreferredDriveLetter": "sample string 6"
}

application/xml, text/xml

Sample:
<BridgeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BridgeService.Model">
  <BridgeProcessId>1a6687b8-b403-43a5-8fc7-248d9ed2f114</BridgeProcessId>
  <MethodPaymentCd>sample string 3</MethodPaymentCd>
  <PaymentPlanCd>sample string 4</PaymentPlanCd>
  <PreferredDriveLetter>sample string 6</PreferredDriveLetter>
  <SavedRateId>d0f3c4b5-ca2d-48d2-abd0-45e65cf62aad</SavedRateId>
  <Term>sample string 5</Term>
</BridgeRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BridgeResponse
NameDescriptionTypeAdditional information
BridgeUrl

string

None.

ReturnCode

BridgeStatus

None.

ReturnCodeDesc

string

None.

ReturnMessage

string

None.

BridgeProcessId

string

None.

Response Formats

application/json, text/json

Sample:
{
  "BridgeUrl": "sample string 1",
  "ReturnCode": 0,
  "ReturnCodeDesc": "Success",
  "ReturnMessage": "sample string 2",
  "BridgeProcessId": "sample string 3"
}

application/xml, text/xml

Sample:
<BridgeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BridgeService.Model">
  <BridgeProcessId>sample string 3</BridgeProcessId>
  <BridgeUrl>sample string 1</BridgeUrl>
  <ReturnCode>Success</ReturnCode>
  <ReturnMessage>sample string 2</ReturnMessage>
</BridgeResponse>