Jump to

• Request
• Response

Create a Route

post

/invoices/{invoiceGid}/routes

Request

Path Parameters

• invoiceGid(required): string
  Resource ID

Supported Media Types

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

Request Body - application/vnd.oracle.resource+json;type=collection ()

Root Schema : schema

Type: object

Show Source

• items(required): array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.routes"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.routes"
    }
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• intermodalServiceCode: string
  Intermodal service code.
• jctCityCode: string
  Junction city code.
• links: array links
  Read Only: true
• routeSeqNo: number (int32)
  The sequence number for the route on an invoice.
• servprovAliasQualGid: string
  The service provider alias qualifier GID.
• servprovAliasValue: string
  Service provider associated with the route.
• transportModeIdentifier: string
  The transport mode identifier.

{
    "properties":{
        "routeSeqNo":{
            "description":"The sequence number for the route on an invoice.",
            "type":"number",
            "format":"int32"
        },
        "transportModeIdentifier":{
            "description":"The transport mode identifier.",
            "type":"string"
        },
        "servprovAliasQualGid":{
            "description":"The service provider alias qualifier GID.",
            "type":"string"
        },
        "servprovAliasValue":{
            "description":"Service provider associated with the route.",
            "type":"string"
        },
        "intermodalServiceCode":{
            "description":"Intermodal service code.",
            "type":"string"
        },
        "jctCityCode":{
            "description":"Junction city code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

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

Type: object

Show Source

• href: string
• rel: string

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

Request Body - application/vnd.oracle.resource+json;type=singular ()

Root Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• intermodalServiceCode: string
  Intermodal service code.
• jctCityCode: string
  Junction city code.
• links: array links
  Read Only: true
• routeSeqNo: number (int32)
  The sequence number for the route on an invoice.
• servprovAliasQualGid: string
  The service provider alias qualifier GID.
• servprovAliasValue: string
  Service provider associated with the route.
• transportModeIdentifier: string
  The transport mode identifier.

{
    "properties":{
        "routeSeqNo":{
            "description":"The sequence number for the route on an invoice.",
            "type":"number",
            "format":"int32"
        },
        "transportModeIdentifier":{
            "description":"The transport mode identifier.",
            "type":"string"
        },
        "servprovAliasQualGid":{
            "description":"The service provider alias qualifier GID.",
            "type":"string"
        },
        "servprovAliasValue":{
            "description":"Service provider associated with the route.",
            "type":"string"
        },
        "intermodalServiceCode":{
            "description":"Intermodal service code.",
            "type":"string"
        },
        "jctCityCode":{
            "description":"Junction city code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

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

Type: object

Show Source

• href: string
• rel: string

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

Back to Top

Response

Supported Media Types

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

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• intermodalServiceCode: string
  Intermodal service code.
• jctCityCode: string
  Junction city code.
• links: array links
  Read Only: true
• routeSeqNo: number (int32)
  The sequence number for the route on an invoice.
• servprovAliasQualGid: string
  The service provider alias qualifier GID.
• servprovAliasValue: string
  Service provider associated with the route.
• transportModeIdentifier: string
  The transport mode identifier.

{
    "properties":{
        "routeSeqNo":{
            "description":"The sequence number for the route on an invoice.",
            "type":"number",
            "format":"int32"
        },
        "transportModeIdentifier":{
            "description":"The transport mode identifier.",
            "type":"string"
        },
        "servprovAliasQualGid":{
            "description":"The service provider alias qualifier GID.",
            "type":"string"
        },
        "servprovAliasValue":{
            "description":"Service provider associated with the route.",
            "type":"string"
        },
        "intermodalServiceCode":{
            "description":"Intermodal service code.",
            "type":"string"
        },
        "jctCityCode":{
            "description":"Junction city code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

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

Type: object

Show Source

• href: string
• rel: string

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

Back to Top