Create validation

post

/fscmRestApi/resources/11.13.18.05/validateReturnQuantities

Request

Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Default Value: N
    Contains one of the following values: Y or N. If Y, then the item is consigned. If N, then the item is not consigned. The default value is N.
  • Abbreviation that identifies the message that describes the error that occurred when validating the quantity. If the Return Status attribute contains a value of SUCCESS, then the Error Code attribute is empty.
  • Message that describes the error that occurred when validating the quantity. If the Return Status attribute contains a value of SUCCESS, then the Error Explanation attribute is empty.
  • Value that uniquely identifies the parent of the transaction to return.
  • Quantity recommended to return.
  • Status returned by the application when validating the quantity. Valid values are SUCCESS, ERROR, and WARNING. SUCCESS: the application successfully validated the quantity for the transaction. ERROR: this validation failed. WARNING: the validation found a potential problem, but allows the transaction to continue.
  • Secondary quantity recommended to return.
  • Unit of measure for the secondary quantity recommended to return.
  • Abbreviation that identifies the secondary unit of measure.
  • Abbreviation that identifies the document type of the shipment. Valid values include PO, RMA, TRANSFER ORDER, or INVENTORY.
  • Unit of measure for the quantity recommended to return.
  • Abbreviation that identifies the unit of measure.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : validateReturnQuantities-item-response
Type: object
Show Source
  • Read Only: true
    Quantity available to return.
  • Default Value: N
    Contains one of the following values: Y or N. If Y, then the item is consigned. If N, then the item is not consigned. The default value is N.
  • Abbreviation that identifies the message that describes the error that occurred when validating the quantity. If the Return Status attribute contains a value of SUCCESS, then the Error Code attribute is empty.
  • Message that describes the error that occurred when validating the quantity. If the Return Status attribute contains a value of SUCCESS, then the Error Explanation attribute is empty.
  • Links
  • Value that uniquely identifies the parent of the transaction to return.
  • Quantity recommended to return.
  • Status returned by the application when validating the quantity. Valid values are SUCCESS, ERROR, and WARNING. SUCCESS: the application successfully validated the quantity for the transaction. ERROR: this validation failed. WARNING: the validation found a potential problem, but allows the transaction to continue.
  • Secondary quantity recommended to return.
  • Unit of measure for the secondary quantity recommended to return.
  • Abbreviation that identifies the secondary unit of measure.
  • Abbreviation that identifies the document type of the shipment. Valid values include PO, RMA, TRANSFER ORDER, or INVENTORY.
  • Unit of measure for the quantity recommended to return.
  • Abbreviation that identifies the unit of measure.
Back to Top

Examples

This example describes how to validate the returned quantities that a user enters against the quantities that are available to return.

Example cURL Command

Use the following cURL command to submit a request on the REST resource. This example validates a quantity of 1, on source document PO, for transaction 3041458:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/validateReturnQuantities"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
"Quantity" : "1",
"UOMCode" : "Ea",
"SourceDocumentCode" : "PO",
"ParentTransactionId" : "3041458"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "ParentTransactionId" : 3041458,
  "Quantity" : 1,
  "ErrorCode" : null,
  "ErrorExplanation" : null,
  "ReturnStatus" : "SUCCESS",
  "SecondaryQuantity" : 0.08333,
  "SecondaryUOMCode" : "DZ",
  "SecondaryUnitOfMeasure" : null,
  "SourceDocumentCode" : "PO",
  "UOMCode" : "Ea",
  "UnitOfMeasure" : null,
  "ConsignedItems" : "N"
}
Back to Top