Jump to

• Request
• Response

Get Bids

get

/tenders/{iTransactionNo}/serviceProviders/{servprovGid}/bids

Request

Path Parameters

• iTransactionNo(required): string
  Resource ID
• servprovGid(required): string
  Resource ID

Query Parameters

• expand: string
  Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
• fields: string
  Comma-delimited string of field names that you wanted returned in a GET request.
• limit: integer(int32)
  Positive integer value that specifies the maximum number of items returned by the server.
• offset: integer(int32)
  Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
• orderBy: string
  Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
• q: string
  Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
• totalResults: boolean
  Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=collection

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tenders.serviceProviders.bids"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object tenders.serviceProviders.bids

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tenders.serviceProviders.bids"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    }
}

Nested Schema : tenders.serviceProviders.bids

Type: object

Show Source

• bidAmount: bidAmount
  The amount of the bid indicated by this service provider. This attribute is marked as Create-Only.
• bidComment: string
  Stores the user comments for each bid.
• deliveryEta: deliveryEta
  The delivery or dropoff date of the shipment stop.
• destLocationGid: string
  The GID of the destination location of the shipment. This attribute is marked as Create-Only.
• domainName: string
  No description.
• flightInstanceId: number (int64)
  Flight Instance ID to be updated to the shipment, if the bid option is approved. This attribute is marked as Create-Only.
• isApproved: boolean
  The bid is approved by planner.
• isDirectRoute: boolean
  Flag to indicate if the proposed flight is direct or not. This attribute is marked as Create-Only.
• links: array links
  Read Only: true
• pickupDate: pickupDate
  The pickup date of the shipment. This attribute is marked as Create-Only.
• sequenceNo: number (int64)
  The sequence identifier for the spot bid. This attribute is marked as Create-Only.
• sourceLocationGid: string
  The GID of the source location of the shipment. This attribute is marked as Create-Only.
• spotRateGid: string
  Spot rate ID specified while creating this bid option.
• tag1: string
  Stores information about the other fields for each bid.
• tag2: string
  Stores information about the other fields for each bid.
• tag3: string
  Stores information about the other fields for each bid.
• transitTime: transitTime
  The transit time for the shipment. This attribute is marked as Create-Only.
• transportModeGid: string
  A unique identifier to define the transportation mode. This attribute is marked as Create-Only.

{
    "properties":{
        "sequenceNo":{
            "description":"The sequence identifier for the spot bid. This attribute is marked as Create-Only.",
            "type":"number",
            "format":"int64"
        },
        "bidAmount":{
            "description":"The amount of the bid indicated by this service provider. This attribute is marked as Create-Only.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "pickupDate":{
            "description":"The pickup date of the shipment. This attribute is marked as Create-Only.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "sourceLocationGid":{
            "description":"The GID of the source location of the shipment.  This attribute is marked as Create-Only.",
            "type":"string"
        },
        "destLocationGid":{
            "description":"The GID of the destination location of the shipment.  This attribute is marked as Create-Only.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"A unique identifier to define the transportation mode.  This attribute is marked as Create-Only.",
            "type":"string"
        },
        "transitTime":{
            "description":"The transit time for the shipment. This attribute is marked as Create-Only.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "isApproved":{
            "description":"The bid is approved by planner.",
            "type":"boolean"
        },
        "isDirectRoute":{
            "description":"Flag to indicate if the proposed flight is direct or not. This attribute is marked as Create-Only.",
            "type":"boolean"
        },
        "flightInstanceId":{
            "description":"Flight Instance ID to be updated to the shipment, if the bid option is approved. This attribute is marked as Create-Only.",
            "type":"number",
            "format":"int64"
        },
        "spotRateGid":{
            "description":"Spot rate ID specified while creating this bid option.",
            "type":"string"
        },
        "tag1":{
            "description":"Stores information about the other fields for each bid.",
            "type":"string"
        },
        "tag2":{
            "description":"Stores information about the other fields for each bid.",
            "type":"string"
        },
        "tag3":{
            "description":"Stores information about the other fields for each bid.",
            "type":"string"
        },
        "bidComment":{
            "description":"Stores the user comments for each bid.",
            "type":"string"
        },
        "deliveryEta":{
            "description":"The delivery or dropoff date of the shipment stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : bidAmount

The amount of the bid indicated by this service provider. This attribute is marked as Create-Only.

Match All

The amount of the bid indicated by this service provider. This attribute is marked as Create-Only.

Show Source

• object currencyType

{
    "description":"The amount of the bid indicated by this service provider. This attribute is marked as Create-Only.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : deliveryEta

The delivery or dropoff date of the shipment stop.

Match All

The delivery or dropoff date of the shipment stop.

Show Source

• object dateTimeType

{
    "description":"The delivery or dropoff date of the shipment stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : pickupDate

The pickup date of the shipment. This attribute is marked as Create-Only.

Match All

The pickup date of the shipment. This attribute is marked as Create-Only.

Show Source

• object dateTimeType

{
    "description":"The pickup date of the shipment. This attribute is marked as Create-Only.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : transitTime

The transit time for the shipment. This attribute is marked as Create-Only.

Match All

The transit time for the shipment. This attribute is marked as Create-Only.

Show Source

• object amountType

{
    "description":"The transit time for the shipment. This attribute is marked as Create-Only.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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"
        }
    }
}

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 : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

Back to Top