SaveRFX (POST) | GEP TECH DOCUMENTATION

Overview

This POST API allows pushing RFQ posted in ERP to GEP SMART for further processing.

URL Format: https://<Instance>/SmartInterfaceAPI/api/RFX/RFXDetails

Request

{
   "eventType": "string",
   "eventCurrency": "string",
   "eventValue": "string",
   "category": [
      "string"
   ],
   "region": [
      "string"
   ],
   "eventTemplateType": "string",
   "eventTimeline": {
      "response": {
         "name": "string",
         "startDate": "2019-12-24T09:53:39.567Z",
         "endDate": "2019-12-24T09:53:39.567Z",
         "visibletosupplier": true
      },
      "evaluation": {
         "name": "string",
         "startDate": "2019-12-24T09:53:39.567Z",
         "endDate": "2019-12-24T09:53:39.567Z",
         "visibletosupplier": true
      },
      "others": [
         {
            "name": "string",
            "startDate": "2019-12-24T09:53:39.567Z",
            "endDate": "2019-12-24T09:53:39.567Z",
            "visibletosupplier": true
         }
      ]
   },
   "suppliers": [
      {
         "name": "string",
         "supplierContacts": [
            {
               "clientContactCode": "string",
               "isPrimary": true,
               "role": "string"
            }
         ],
         "primaryRespondant": "string",
         "responseCompletionStatus": "string",
         "participationStatus": "string",
         "shortlistedForFeedback": true
      }
   ],
   "priceSheets": [
      {
         "priceSheetName": "string",
         "description": "string",
         "priceSheetType": "string",
         "createdBy": "string",
         "lastModifiedBy": "string",
         "columns": [
            {
               "name": "string",
               "type": "string",
               "mandatory": true,
               "visibleToSupplier": true,
               "forSupplierResponse": true
            }
         ],
         "rows": [
            {
               "rowNumber": 0,
               "data": [
                  {
                     "columnName": "string",
                     "columnValue": "string"
                  }
               ]
            }
         ]
      }
   ],
   "attachments": [
      {
         "name": "string",
         "base64Attachment": "string"
      }
   ],
   "guidelines": [
      {
         "guidelineName": "string",
         "guidelineType": "string",
         "guidelineData": "string",
         "createdBy": "string",
         "lastModifiedBy": "string"
      }
   ],
   "documentName": "string",
   "documentNumber": "string",
   "documentStatus": "string",
   "documentDescription": "string",
   "documentCreator": "string",
   "documentBU": [
      {
         "entityCode": "string",
         "isDefault": true,
         "entityType": "string",
         "lobEntityCode": "string"
      }
   ],
   "header": {
      "from": {
         "domain": "string",
         "identity": "string"
      },
      "to": {
         "domain": "string",
         "identity": "string"
      },
      "sender": {
         "domain": "string",
         "identity": "string",
         "sharedSecret": "string",
         "userAgent": "string"
      }
   },
   "operationName": "string"
}

Response

{
   "data": {},
   "statusCode": "String",
   "errorDetails": [
      {
         "key": "string",
         "errors": [
            {
               "errorCode": "string",
               "errorDescription": "string"
            }
         ]
      }
   ],
   "successDetails": 
      {
         "key": "String"
      }
   ]
}

Examples

Success Scenario – Request

{
   "EventType": "RFQ",
   "EventValue": "10.0",
   "Category": [
      "44224550001846"
   ],
   "Region": [
      "UNITED STATES OF AMERICA"
   ],
   "EventTemplateType": "AutoPublish",
   "EventTimeline": {
      "Response": {
         "Name": "string",
         "StartDate": "2019-12-03T12:34:06.813Z",
         "EndDate": "2020-01-04T12:34:06.813Z",
         "Visibletosupplier": true
      },
      "Evaluation": {
         "Name": "string",
         "StartDate": "2020-01-05T12:40:06.813Z",
         "EndDate": "2020-01-06T12:34:06.813Z",
         "Visibletosupplier": true
      },
      "Others": [
         {
            "Name": "string",
            "StartDate": "2019-08-28T12:34:06.814Z",
            "EndDate": "2019-08-28T12:34:06.814Z",
            "Visibletosupplier": true
         }
      ]
   },
   "Suppliers": [
      {
         "Name": "PC-2017.001307",
         "SupplierContacts": [
            {
               "ClientContactCode": "CC-2019.015736",
               "IsPrimary": true,
               "Role": "stringrole"
            }
         ]
      },
      {
         "Name": "PC-2017.001591",
         "SupplierContacts": [
            {
               "ClientContactCode": "CC-2017.001683",
               "IsPrimary": true,
               "Role": "stringrole"
            }
         ]
      },
      {
         "Name": "PC-2017.000040",
         "SupplierContacts": [
            {
               "ClientContactCode": "CC-2017.000132",
               "IsPrimary": true,
               "Role": "stringrole"
            }
         ]
      }
   ],
   "PriceSheets": [
      {
         "PriceSheetName": "Header_Note1This Blanket Purchase Order is awarded to supply Company requirements for &#39; through.",
         "Description": "desc1",
         "PriceSheetType": "Material",
         "CreatedBy": "CreatedBystring",
         "LastModifiedBy": "LastModifiedBystring",
         "Columns": [
            {
               "Name": "col1",
               "Type": "Text",
               "Mandatory": true,
               "VisibleToSupplier": true,
               "ForSupplierResponse": false
            },
            {
               "Name": "col2",
               "Type": "Text",
               "Mandatory": false,
               "VisibleToSupplier": true,
               "ForSupplierResponse": false
            }
         ],
         "Rows": [
            {
               "RowNumber": 1,
               "Data": [
                  {
                     "ColumnName": "col1",
                     "ColumnValue": "11"
                  }
               ]
            }
         ]
      },
      {
         "PriceSheetName": "Header_Note2This Blanket Purchase Order is awarded to supply Company requirements for &#39; through.",
         "Description": "desc2",
         "PriceSheetType": "Material",
         "CreatedBy": "CreatedBystring",
         "LastModifiedBy": "LastModifiedBystring",
         "Columns": [
            {
               "Name": "col1",
               "Type": "Text",
               "Mandatory": true,
               "VisibleToSupplier": true,
               "ForSupplierResponse": false
            },
            {
               "Name": "col2",
               "Type": "Numeric",
               "Mandatory": false,
               "VisibleToSupplier": true,
               "ForSupplierResponse": false
            }
         ],
         "Rows": [
            {
               "RowNumber": 1,
               "Data": [
                  {
                     "ColumnName": "col1",
                     "ColumnValue": "test"
                  },
                  {
                     "ColumnName": "col2",
                     "ColumnValue": "11"
                  }
               ]
            },
            {
               "RowNumber": 2,
               "Data": [
                  {
                     "ColumnName": "col1",
                     "ColumnValue": "test2"
                  },
                  {
                     "ColumnName": "col2",
                     "ColumnValue": "12"
                  }
               ]
            }
         ]
      }
   ],
   "Attachments": [
      {
         "Name": "attch1.txt",
         "Base64Attachment": "VGVzdEF0dGFjaG1lbnRzMQ=="
      },
      {
         "Name": "atch2.txt",
         "Base64Attachment": "VGVzdEF0dGFjaG1lbnRCb2R5Mg=="
      }
   ],
   "DocumentName": "Header_Note3This Blanket Purchase Order is awarded to supply Company requirements for &#39; through.",
   "DocumentNumber": "OWL_001114",
   "DocumentStatus": "Published",
   "DocumentDescription": "Desc",
   "DocumentCreator": "AscenaAdminUAT",
   "DocumentBU": [
      {
         "EntityCode": "SAP",
         "IsDefault": false,
         "EntityType": "Division",
         "LOBEntityCode": "SAP"
      },
      {
         "EntityCode": "Oracle",
         "IsDefault": "true",
         "EntityType": "Division",
         "LOBEntityCode": "Oracle"
      }
   ],
   "Header": {
      "From": {
         "Domain": "Ascena",
         "Identity": "Ascena"
      },
      "To": {
         "Domain": "Gep-Cumulus",
         "Identity": "GEP"
      },
      "Sender": {
         "Domain": "Ascena",
         "Identity": "Ascena",
         "SharedSecret": "Ascena@123",
         "UserAgent": "Ascena-Suite"
      }
   },
   "OperationName": "New"
}

Success Scenario – Response

{
   "data": null,
   "statusCode": "200",
   "errorDetails": [],
   "successDetails": [
      {
         "key": "OWL_001114"
      }
   ]
}

Error Scenario – Request

{
   "EventType": "RFQ",
   "EventValue": "10.0",
   "Category": [
      "44224550001846"
   ],
   "Region": [
      "UNITED STATES OF AMERICA"
   ],
   "EventTemplateType": "AutoPublish",
   "EventTimeline": {
      "Response": {
         "Name": "string",
         "StartDate": "2019-12-03T12:34:06.813Z",
         "EndDate": "2020-01-04T12:34:06.813Z",
         "Visibletosupplier": true
      },
      "Evaluation": {
         "Name": "string",
         "StartDate": "2019-12-05T12:40:06.813Z",
         "EndDate": "2019-12-06T12:34:06.813Z",
         "Visibletosupplier": true
      },
      "Others": [
         {
            "Name": "string",
            "StartDate": "2019-08-28T12:34:06.814Z",
            "EndDate": "2019-08-28T12:34:06.814Z",
            "Visibletosupplier": true
         }
      ]
   },
   "Suppliers": [
      {
         "Name": "PC-2017.001307",
         "SupplierContacts": [
            {
               "ClientContactCode": "CC-2019.015736",
               "IsPrimary": true,
               "Role": "stringrole"
            }
         ]
      },
      {
         "Name": "PC-2017.001591",
         "SupplierContacts": [
            {
               "ClientContactCode": "CC-2017.001683",
               "IsPrimary": true,
               "Role": "stringrole"
            }
         ]
      },
      {
         "Name": "PC-2017.000040",
         "SupplierContacts": [
            {
               "ClientContactCode": "CC-2017.000132",
               "IsPrimary": true,
               "Role": "stringrole"
            }
         ]
      }
   ],
   "PriceSheets": [
      {
         "PriceSheetName": "Header_Note1This Blanket Purchase Order is awarded to supply Company requirements for &#39; through.",
         "Description": "desc1",
         "PriceSheetType": "Material",
         "CreatedBy": "CreatedBystring",
         "LastModifiedBy": "LastModifiedBystring",
         "Columns": [
            {
               "Name": "col1",
               "Type": "Text",
               "Mandatory": true,
               "VisibleToSupplier": true,
               "ForSupplierResponse": false
            },
            {
               "Name": "col2",
               "Type": "Text",
               "Mandatory": false,
               "VisibleToSupplier": true,
               "ForSupplierResponse": false
            }
         ],
         "Rows": [
            {
               "RowNumber": 1,
               "Data": [
                  {
                     "ColumnName": "col1",
                     "ColumnValue": "11"
                  }
               ]
            }
         ]
      },
      {
         "PriceSheetName": "Header_Note2This Blanket Purchase Order is awarded to supply Company requirements for &#39; through.",
         "Description": "desc2",
         "PriceSheetType": "Material",
         "CreatedBy": "CreatedBystring",
         "LastModifiedBy": "LastModifiedBystring",
         "Columns": [
            {
               "Name": "col1",
               "Type": "Text",
               "Mandatory": true,
               "VisibleToSupplier": true,
               "ForSupplierResponse": false
            },
            {
               "Name": "col2",
               "Type": "Numeric",
               "Mandatory": false,
               "VisibleToSupplier": true,
               "ForSupplierResponse": false
            }
         ],
         "Rows": [
            {
               "RowNumber": 1,
               "Data": [
                  {
                     "ColumnName": "col1",
                     "ColumnValue": "test"
                  },
                  {
                     "ColumnName": "col2",
                     "ColumnValue": "11"
                  }
               ]
            },
            {
               "RowNumber": 2,
               "Data": [
                  {
                     "ColumnName": "col1",
                     "ColumnValue": "test2"
                  },
                  {
                     "ColumnName": "col2",
                     "ColumnValue": "12"
                  }
               ]
            }
         ]
      }
   ],
   "Attachments": [
      {
         "Name": "attch1.txt",
         "Base64Attachment": "VGVzdEF0dGFjaG1lbnRzMQ=="
      },
      {
         "Name": "atch2.txt",
         "Base64Attachment": "VGVzdEF0dGFjaG1lbnRCb2R5Mg=="
      }
   ],
   "DocumentName": "Header_Note3This Blanket Purchase Order is awarded to supply Company requirements for &#39; through.",
   "DocumentNumber": "OWL_0016",
   "DocumentStatus": "Published",
   "DocumentDescription": "Desc",
   "DocumentCreator": "AscenaAdminUAT",
   "DocumentBU": [
      {
         "EntityCode": "SAP",
         "IsDefault": false,
         "EntityType": "Division",
         "LOBEntityCode": "SAP"
      },
      {
         "EntityCode": "Oracle",
         "IsDefault": "true",
         "EntityType": "Division",
         "LOBEntityCode": "Oracle"
      }
   ],
   "Header": {
      "From": {
         "Domain": "Ascena",
         "Identity": "Ascena"
      },
      "To": {
         "Domain": "Gep-Cumulus",
         "Identity": "GEP"
      },
      "Sender": {
         "Domain": "Ascena",
         "Identity": "Ascena",
         "SharedSecret": "Ascena@123",
         "UserAgent": "Ascena-Suite"
      }
   },
   "OperationName": "New"
}

Error Scenario – Response

{
   "data": null,
   "statusCode": "400",
   "errorDetails": [
      {
         "key": "OWL_0016",
         "errors": [
            {
               "errorCode": "DataValidation",
               "errorDescription": "Response timeline end date must be before Evaluation timeline end date."
            }
         ]
      }
   ],
   "successDetails": []
}

Data Elements

	RFX
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.1	EventType	Yes	String	Type of an event	Event Type is mandatory Event Type is invalid
1.2	EventCurrency	Yes	String	Currency for the event	There was an error in processing as it contains invalid Event Currency
1.3	EventValue	Yes	String	Event value	Event Value should be decimal type
1.4	Category	Yes	List of string	Category for an event	Category is mandatory Category at position () is mandatory There was an error in processing as it contains invalid Category ()
1.5	Region	Yes	List of string	Region	Region is mandatory Region at position () is mandatory There was an error in processing as it contains invalid Region name(s)
1.6	EventTemplateType	Yes	String		If document Status is Published, then below validation exist Event Template Type is mandatory Event Template Type is invalid
1.7	EventTimeline	Yes	EventTimeline object	Timelines for an event	If document Status is Published, then below validation exist EventTimeline is mandatory
1.8	Suppliers	Yes	List of Supplier object	List of suppliers associated with an event	Supplier is mandatory
1.9	PriceSheets		List of PriceSheet object	Price sheet for an event	If document Status is Published, then below validation exist Price Sheet is mandatory
1.10	Attachments	No	List of Attachment object	Attachment list
1.11	Guidelines	No	List of Guidelines object	Guidelines to be followed for an event

	EventTimeline
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.7.1	Response	No	Timeline object	Response timeline	Response is mandatory in Event TimeLine
1.7.2	Evaluation	No	Timeline object	Evaluation timeline	Evaluation is mandatory in Event TimeLine
1.7.3	Others	No	List of Timeline object

	Response
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.7.1.1	Name	Yes	String	Evaluation and Response name	EventTimeline Evaluation name is mandatory EventTimeline Response name is mandatory
1.7.1.2	StartDate	Yes	DateTime	Response start date	Evaluation start date should be greater than or equal to the response start date
1.7.1. 3	EndDate	Yes	DateTime	Response end date	Response timeline end date must be before Evaluation timeline end date Evaluation end date should be greater than or equal to the start date Response end date should be greater than or equal to the current date Response end date should greater than or equal to start date
1.7.1.4	Visibletosupplier	No	Boolean

	Suppliers
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1. 8.1	Name	Yes	String	Name of the supplier	Supplier Name at position () is mandatory There was an error in processing as it contains invalid Partner(s) There was an error in processing as it cannot contains invalid Partner(s)
1. 8.2	SupplierContacts	Yes	List of SupplierContact object	Supplier contacts	Supplier Contacts are mandatory for Supplier ()
1. 8.3	PrimaryRespondant	No	String
1. 8.4	ResponseCompletionStatus	No	String
1. 8.5	ParticipationStatus	No	String
1. 8.6	ShortlistedForFeedback	No	Boolean

	SupplierContacts
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1. 8.2.1	ClientContactCode	Yes	String		Client Contact Code in Supplier Contacts is mandatory for Supplier () There was an error in processing as it contains invalid Owner There was an error in processing as Supplier contains invalid Contact(s) Contact Code is not mapped to BU
1. 8.2.2	IsPrimary	No	Boolean
1. 8.2.3	Role	No	String

	PriceSheets
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.9.1	PriceSheetName	Yes	String	Price sheet	Price Sheet Name is mandatory for price sheet at position () Price Sheet Name should be less than or equal to 100 characters for () Price Sheet
1.9.2	Description	No	String	Description for price sheet	Price Sheet description should be less than or equal to 4000 characters for () Price Sheet
1.9.3	PriceSheetType	Yes	String		Price Sheet Type is mandatory for (Price Sheet Name) Price Sheet Type is invalid for (Price Sheet Name) Price Sheet
1.9.4	CreatedBy	No	String	Creation date
1.9.5	LastModifiedBy	No	String	last updated by
1. 9.6	Columns	No	List of Columns object
1. 9.7	Rows	No	List of Rows object

	Columns
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1. 9.6.1	Name	Yes	String		Price Sheet column name is mandatory for Price Sheet (Price Sheet Name) in column
1. 9.6.2	Type	No	String		Price Sheet column type is mandatory for Price Sheet (Price Sheet Name) in column Price Sheet column type is invalid for Price Sheet (Price Sheet Name) in column
1. 9.6.3	Mandatory	No	Boolean
1. 9.6.4	VisibleToSupplier	No	Boolean
1. 9.6.5	ForSupplierResponse	No	Boolean

	Rows
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1. 9.7.1	RowNumber	No	Int		Row Number already exist for Price Sheet (Price Sheet Name)
1. 9.7.2	Data	No	List of lineData object		Data is mandatory for Price Sheet (Price Sheet Name) at row (Row Number) for column Row count should not be more than column count at Row Number (Row Number) for Price Sheet (Price Sheet Name)

	Data
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1. 8.2.7.2 .1	ColumnName	Yes	String		Data column name not exists in Price Sheet (Price Sheet Name) columns at position for Row Number Data column name (Row Number) not exists in Price Sheet (Price Sheet Name) columns
1. 8.2.7.2 .2	ColumnValue	No	String		String length is greater than 500 characters for Price Sheet (Price Sheet Name) at row (Row Number) for column (Name) Data type mismatch for Price Sheet (Price Sheet Name) at row (Row Number) for column (Name)

	Attachments
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.10.1	Name	No	String
1.10.2	Base64Attachment	No	String

	Guidelines
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.11.1	GuidelineName	No	String	Name of the guideline
1.11.2	GuidelineType	No	String	Type of the guideline
1.11.3	GuidelineData	No	String	Information related to guideline
1.11.4	CreatedBy	No	String	Creator for the guideline
1.11.5	LastModifiedBy	No	String	Name of the persona who last updated the guideline

	Document
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1. 12 .1	DocumentName	Yes	String	Name of the document	Document Name is mandatory Document Name Should be less than or equal to 100 characters
1. 12 .2	DocumentNumber	Yes	String	Number of the document	Document Number is mandatory There was an error in processing as the Document Number already exists
1. 12 .3	DocumentStatus	Yes	String	Status of the document	Document Status is mandatory Document Status is invalid
1. 12 .4	DocumentDescription	No	String	Description/ more information related to the document	Document Description Should be less than or equal to 4000 characters
1. 12.5	DocumentCreator	Yes	String	Creator of the document	Document Creator is mandatory
1. 12.6	DocumentBU	Yes	List of orgentity object	Document business unit	Business Unit is mandatory
1. 12.7	Header	Yes	Header of object	Check Header for details
1. 12.8	OperationName	Yes	String		Operation name is mandatory

	DocumentBU
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1. 12.6.1	EntityCode	Yes	String	Entity code	Entity Code at () is mandatory for Document BU Invalid Entity Code
1. 12.6.2	IsDefault	No	Boolean
1. 12.6.3	EntityType	Yes	String	Entity type	Entity Type at position () is mandatory for Document BU Invalid Entity Type
1. 12.6.4	LOBEntityCode	No	String		Invalid LOB Entity Code

Header

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.3.1

From

Yes

From object

Check data type From for details

1.3.2

To

Yes

To object

Check data type To for details

1.3.3

Sender

Yes

Sender object

Check data type Sender for details

	From
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.3.1.1	Domain	No	String	Domain of the entity
1.3.1.2	Identity	Yes	String	Identity of the entity

	To
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.3.2.1	Domain	No	String	Domain of the entity
1.3.2.2	Identity	Yes	String	Identity of the entity

	Sender
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.3.3.1	Domain		String	Domain of the entity
1.3.3.2	Identity		String	Identity of the entity
1.3.3.3	SharedSecret		String	Shared Secret of the entity
1.3.3.4	UserAgent		String	User Agent of the entity