Jump to

• Request
• Response

Perform decline action for one or more Tenders

post

/custom-actions/acceptDecline/tenders/

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request parameters for the accept or decline action.

Show Source

• acceptanceCode(required): string
  Acceptance code A for Accept action and D for Decline action
• bidAmount: bidAmount
  Bid amount provided by the service provider when accepting the broadcast tender
• declineReasonCode: string
  Reason for declining the tender
• isRetender: boolean
  Retender to the another service provider when declining the tender
• pks: array pks
  Pass the collab ID(s) pks to perform decline tender for one or more records when the collad ID is not passed in the URL.
• servprovGid: string
  Service provider ID when accepting/declining the broadcast tender

{
    "description":"Request parameters for the accept or decline action.",
    "type":"object",
    "properties":{
        "acceptanceCode":{
            "description":"Acceptance code A for Accept action and D for Decline action",
            "type":"string"
        },
        "servprovGid":{
            "description":"Service provider ID when accepting/declining the broadcast tender",
            "type":"string"
        },
        "bidAmount":{
            "description":"Bid amount provided by the service provider when accepting the broadcast tender",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "pks":{
            "description":"Pass the collab ID(s) pks to perform decline tender for one or more records when the collad ID is not passed in the URL.",
            "type":"array"
        },
        "isRetender":{
            "description":"Retender to the another service provider when declining the tender",
            "type":"boolean"
        },
        "declineReasonCode":{
            "description":"Reason for declining the tender",
            "type":"string"
        }
    },
    "required":[
        "acceptanceCode"
    ]
}

Nested Schema : bidAmount

Bid amount provided by the service provider when accepting the broadcast tender

Match All

Show Source

• object currencyType

{
    "description":"Bid amount provided by the service provider when accepting the broadcast tender",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : pks

Type: array

Pass the collab ID(s) pks to perform decline tender for one or more records when the collad ID is not passed in the URL.

Nested Schema : currencyType

Type: object

Show Source

• currency: string
  ISO 4217 currency code
• value: number
  Numeric value that specifies a currency

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies a currency",
            "type":"number"
        },
        "currency":{
            "description":"ISO 4217 currency code",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Default Response.

Body ()

Root Schema : acceptDeclineResponse

Type: object

Response after accept or decline the tender.

Show Source

• items: array items
  Accepte or Decline response for tender.

{
    "description":"Response after accept or decline the tender.",
    "type":"object",
    "properties":{
        "items":{
            "description":"Accepte or Decline response for tender.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/resultItem"
            }
        }
    }
}

Nested Schema : items

Type: array

Accepte or Decline response for tender.

Show Source

• Array of: object resultItem

{
    "description":"Accepte or Decline response for tender.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/resultItem"
    }
}

Nested Schema : resultItem

Type: object

Show Source

• endTime: endTime
  The end time.
• equipmentGroup: string
  The equipment group.
• rateOffering: string
  The rate offering.
• serviceProviderID: string
  The service provider ID.
• shipmentPk: string
  The primary key for the shipment.
• startTime: startTime
  The start time.
• totalActualCost: totalActualCost
  The total actual cost.
• totalWeightedCost: totalWeightedCost
  The total weighted cost.
• transportMode: string
  The transport mode.

{
    "properties":{
        "shipmentPk":{
            "description":"The primary key for the shipment.",
            "type":"string"
        },
        "totalActualCost":{
            "description":"The total actual cost.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalWeightedCost":{
            "description":"The total weighted cost.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "startTime":{
            "description":"The start time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endTime":{
            "description":"The end time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "serviceProviderID":{
            "description":"The service provider ID.",
            "type":"string"
        },
        "transportMode":{
            "description":"The transport mode.",
            "type":"string"
        },
        "rateOffering":{
            "description":"The rate offering.",
            "type":"string"
        },
        "equipmentGroup":{
            "description":"The equipment group.",
            "type":"string"
        }
    }
}

Nested Schema : endTime

The end time.

Match All

Show Source

• object dateTimeType

{
    "description":"The end time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : startTime

The start time.

Match All

Show Source

• object dateTimeType

{
    "description":"The start time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : totalActualCost

The total actual cost.

Match All

Show Source

• object currencyType

{
    "description":"The total actual cost.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalWeightedCost

The total weighted cost.

Match All

Show Source

• object currencyType

{
    "description":"The total weighted cost.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : currencyType

Type: object

Show Source

• currency: string
  ISO 4217 currency code
• value: number
  Numeric value that specifies a currency

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies a currency",
            "type":"number"
        },
        "currency":{
            "description":"ISO 4217 currency code",
            "type":"string"
        }
    }
}

Back to Top