Jump to

• Request
• Response

Create Transfer

post

/services/private/Transfer

This service is used to create transfer.

Request

Header Parameters

• Accept-Language:
  Accept-Language header

  Example:

  en-US

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• attributeNames: array attributeNames
• attributes: array attributes
• commentDesc: string
• contextType: string
• contextValue: string
• deliveryDate: integer (int64)
• dept: integer (int64)
• freightCode: string
• fromLoc: string
• fromLocType: string
• hyperMediaContent: object hyperMediaContent
• jsonFieldNameMap: object jsonFieldNameMap
  Additional Properties Allowed: additionalProperties
• links: array links
• routingCode: string
• status: string
• toLoc: string
• toLocType: string
• tsfdtlRDOs: array tsfdtlRDOs
• tsfNo: integer (int64)
• tsfType: string
• userId: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "attributeNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "attributes":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jsonFieldNameMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "tsfNo":{
            "type":"integer",
            "format":"int64"
        },
        "fromLocType":{
            "type":"string"
        },
        "fromLoc":{
            "type":"string"
        },
        "toLocType":{
            "type":"string"
        },
        "toLoc":{
            "type":"string"
        },
        "deliveryDate":{
            "type":"integer",
            "format":"int64"
        },
        "dept":{
            "type":"integer",
            "format":"int64"
        },
        "routingCode":{
            "type":"string"
        },
        "freightCode":{
            "type":"string"
        },
        "tsfType":{
            "type":"string"
        },
        "tsfdtlRDOs":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Xtsfdtl"
            }
        },
        "status":{
            "type":"string"
        },
        "userId":{
            "type":"string"
        },
        "commentDesc":{
            "type":"string"
        },
        "contextType":{
            "type":"string"
        },
        "contextValue":{
            "type":"string"
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : attributeNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : jsonFieldNameMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : tsfdtlRDOs

Type: array

Show Source

• Array of: object Xtsfdtl

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

Nested Schema : items

Type: object

Nested Schema : Link

Type: object

Show Source

• href: string
• methodType: string
• rel: string
• type: string

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

Nested Schema : Xtsfdtl

Type: object

Show Source

• attributeNames: array attributeNames
• attributes: array attributes
• hyperMediaContent: object hyperMediaContent
• invStatus: integer (int64)
• item: string
• jsonFieldNameMap: object jsonFieldNameMap
  Additional Properties Allowed: additionalProperties
• links: array links
• suppPackSize: number
• tsfQty: number
• unitCost: number

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "attributeNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "attributes":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jsonFieldNameMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "item":{
            "type":"string"
        },
        "tsfQty":{
            "type":"number"
        },
        "suppPackSize":{
            "type":"number"
        },
        "invStatus":{
            "type":"integer",
            "format":"int64"
        },
        "unitCost":{
            "type":"number"
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : attributeNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : jsonFieldNameMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : items

Type: object

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• attributeNames: array attributeNames
• attributes: array attributes
• commentDesc: string
• contextType: string
• contextValue: string
• deliveryDate: integer (int64)
• dept: integer (int64)
• freightCode: string
• fromLoc: string
• fromLocType: string
• hyperMediaContent: object hyperMediaContent
• jsonFieldNameMap: object jsonFieldNameMap
  Additional Properties Allowed: additionalProperties
• links: array links
• routingCode: string
• status: string
• toLoc: string
• toLocType: string
• tsfdtlRDOs: array tsfdtlRDOs
• tsfNo: integer (int64)
• tsfType: string
• userId: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "attributeNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "attributes":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jsonFieldNameMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "tsfNo":{
            "type":"integer",
            "format":"int64"
        },
        "fromLocType":{
            "type":"string"
        },
        "fromLoc":{
            "type":"string"
        },
        "toLocType":{
            "type":"string"
        },
        "toLoc":{
            "type":"string"
        },
        "deliveryDate":{
            "type":"integer",
            "format":"int64"
        },
        "dept":{
            "type":"integer",
            "format":"int64"
        },
        "routingCode":{
            "type":"string"
        },
        "freightCode":{
            "type":"string"
        },
        "tsfType":{
            "type":"string"
        },
        "tsfdtlRDOs":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Xtsfdtl"
            }
        },
        "status":{
            "type":"string"
        },
        "userId":{
            "type":"string"
        },
        "commentDesc":{
            "type":"string"
        },
        "contextType":{
            "type":"string"
        },
        "contextValue":{
            "type":"string"
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : attributeNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : jsonFieldNameMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : tsfdtlRDOs

Type: array

Show Source

• Array of: object Xtsfdtl

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

Nested Schema : items

Type: object

Nested Schema : Link

Type: object

Show Source

• href: string
• methodType: string
• rel: string
• type: string

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

Nested Schema : Xtsfdtl

Type: object

Show Source

• attributeNames: array attributeNames
• attributes: array attributes
• hyperMediaContent: object hyperMediaContent
• invStatus: integer (int64)
• item: string
• jsonFieldNameMap: object jsonFieldNameMap
  Additional Properties Allowed: additionalProperties
• links: array links
• suppPackSize: number
• tsfQty: number
• unitCost: number

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "attributeNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "attributes":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jsonFieldNameMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "item":{
            "type":"string"
        },
        "tsfQty":{
            "type":"number"
        },
        "suppPackSize":{
            "type":"number"
        },
        "invStatus":{
            "type":"integer",
            "format":"int64"
        },
        "unitCost":{
            "type":"number"
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : attributeNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : jsonFieldNameMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : items

Type: object

Back to Top

Response

Supported Media Types

• */*

Default Response

default response

Back to Top