GetRFQResponse (GET)

Overview

This GET API allows retrieval of RFQ details created in GEP SMART to post them into ERP.

 

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

Request

https://<Instance>/SmartInterfaceAPI/api/RFX/RFQResponse

Response
{
   "data": [
      {
         "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"
            }
         ],
         "operationName": "string"
      }
   ],
   "statusCode": "String",
   "errorDetails": [
      {
         "key": "string",
         "errors": [
            {
               "errorCode": "string",
               "errorDescription": "string"
            }
         ]
      }
   ],
   "successDetails": [
      {
         "key": "String"
      }
   ]
}

 

Examples

Success Scenario – Request

https://<Instance>/SmartInterfaceAPI/api/RFX/RFQResponse

 

Success Scenario – Response

{
   "data": [
      {
         "EventType": "1",
         "EventCurrency": "USD",
         "EventValue": "",
         "Category": [
            "44224550002614"
         ],
         "Region": [
            "CANADA"
         ],
         "EventTemplateType": "0",
         "EventTimeline": {},
         "Suppliers": [
            {
               "Name": "",
               "SupplierContacts": [
                  {
                     "ClientContactCode": ""
                  }
               ]
            }
         ],
         "PriceSheets": [
            {
               "PriceSheetName": "Materials",
               "Description": "",
               "PriceSheetType": "0",
               "CreatedBy": "",
               "LastModifiedBy": "",
               "Columns": [
                  {
                     "Name": "Item name",
                     "Type": "Text",
                     "Mandatory": true,
                     "VisibleToSupplier": true
                  },
                  {
                     "Name": "Item number",
                     "Type": "Text",
                     "VisibleToSupplier": true
                  },
                  {
                     "Name": "Volume",
                     "Type": "Numeric",
                     "Mandatory": true,
                     "VisibleToSupplier": true
                  },
                  {
                     "Name": "Unit",
                     "Type": "Drop Down",
                     "Mandatory": true,
                     "VisibleToSupplier": true
                  },
                  {
                     "Name": "Baseline price per unit",
                     "Type": "Currency"
                  },
                  {
                     "Name": "Total baseline price",
                     "Type": "Computed"
                  },
                  {
                     "Name": "Price per unit",
                     "Type": "Currency",
                     "Mandatory": true,
                     "VisibleToSupplier": true,
                     "ForSupplierResponse": true
                  },
                  {
                     "Name": "Total price",
                     "Type": "Computed",
                     "VisibleToSupplier": true
                  },
                  {
                     "Name": "Line Number",
                     "Type": "Text",
                     "Mandatory": true,
                     "VisibleToSupplier": true
                  }
               ],
               "Rows": []
            }
         ],
         "Attachments": [],
         "Guidelines": [
            {
               "GuidelineName": "",
               "GuidelineType": "0",
               "GuidelineData": ""
            }
         ],
         "DocumentName": "testReq7",
         "DocumentNumber": "198694-Aug2019",
         "DocumentStatus": "0",
         "DocumentDescription": "",
         "DocumentCreator": "AscenaRetail Admin Test 12",
         "DocumentBU": [
            {
               "EntityCode": "C5004",
               "EntityType": "Logical Store",
               "LOBEntityCode": "Oracle"
            }
         ],
         "OperationName": ""
      }
   ],
   "statusCode": "200",
   "errorDetails": [],
   "successDetails": []
}

 

Error Scenario – Request

https://<Instance>/SmartInterfaceAPI/api/RFX/RFQResponse

 

Error Scenario – Response No records found

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

 

Data Elements
 

GetRFQResponse

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1

Data

 

List of REQResponse object

REQ Response object

 

2

StatusCode

 

String(100)

StatusCode

 

3

ErrorDetails

 

List of Error object

ErrorDetails

 

4

SuccessDetails

 

List of Success object

SuccessDetails

 

 

Data

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.1

EventType

 

String

Event Type

 

1.2

EventCurrency

 

String

Event Currency

 

1.3

EventValue

 

String

Even tValue

 

1.4

Category

 

List of string

Category

 

1.5

Region

 

List of string

Region

 

1.6

EventTemplateType

 

String

Event Template Type

 

1.7

EventTimeline

 

EventTimeline object

Event Timeline

 

1.8

Suppliers

 

List of Supplier object

Suppliers

 

1.9

PriceSheets

 

List of PriceSheet object

Price Sheets

 

1.10

Attachments

 

List of Attachment object

Attachments

 

1.11

Guidelines

 

List of Guidelines object

Guide lines

 

1.12

Document

 

List of Document object

Document

 

 

EventTimeline

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.7.1

Response

 

Timeline object

Response

 

1.7.2

Evaluation

 

Timeline object

Evaluation

 

1.7.3

Others

 

List of Timeline object

Others

 

 

Response

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.7.1.1

Name

 

String

Name

 

1.7.1.2

StartDate

 

DateTime

Start Date

 

1.7.1. 3

EndDate

 

DateTime

End Date

 

1.7.1.4

Visibletosupplier

 

Boolean

Visibletosupplier

 

 

Supplier

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1. 8.1

Name

 

String

Name

 

1. 8.2

SupplierContacts

 

List of SupplierContact object

Supplier Contacts

 

1. 8.3

PrimaryRespondant

 

String

Primary Respondent

 

1. 8.4

ResponseCompletionStatus

 

String

Response Completion Status

 

1. 8.5

ParticipationStatus

 

String

Participation Status

 

1. 8.6

ShortlistedForFeedback

 

Boolean

Shortlisted for Feedback

 

 

SupplierContacts

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1. 8.2.1

ClientContactCode

 

String

ClientContactCode

 

1. 8.2.2

IsPrimary

 

Boolean

IsPrimary

 

1. 8.2.3

Role

 

String

Role

 

 

PriceSheets

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.9.1

PriceSheetName

 

String

Price Sheet Name

 

1.9.2

Description

 

String

Description

 

1.9.3

PriceSheetType

 

String

Price Sheet Type

 

1.9.4

CreatedBy

 

String

Created by

 

1.9.5

LastModifiedBy

 

String

Last Modified By

 

1. 8.2.6

Columns

 

List of Columns object

Columns

 

1. 8.2.7

Rows

 

List of Rows object

Rows

 

 

Columns

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1. 8.2. 6.1

Name

 

String

Name

 

1. 8.2.6.2

Type

 

String

Type

 

1. 8.2.6.3

Mandatory

 

Boolean

Mandatory

 

1. 8.2.6.4

VisibleToSupplier

 

Boolean

Visible to Supplier

 

1. 8.2.6.5

ForSupplierResponse

 

Boolean

For Supplier Response

 

 

Rows

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1. 8.2.7.1

RowNumber

 

Int

RowNumber

 

1. 8.2.7.2

Data

 

List of LineData object

Data

 

 

Data

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1. 8.2.7.2 .1

ColumnName

 

String

ColumnName

 

1. 8.2.7.2 .2

ColumnValue

 

String

ColumnValue

 

 

Attachments

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.10.1

Name

 

String

Name

 

1.10.2

Base64Attachment

 

String

Base64 Attachment

 

 

Guidelines

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.11.1

GuidelineName

 

String

Guide line Name

 

1.11.2

GuidelineType

 

String

Guide line Type

 

1.11.3

GuidelineData

 

String

Guide line Data

 

1.11.4

CreatedBy

 

String

Created By

 

1.11.5

LastModifiedBy

 

String

Last Modified By

 

 

Document

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1. 12 .1

DocumentName

 

String

Document Name

 

1. 12 .2

DocumentNumber

 

String

Document Number

 

1. 12 .3

DocumentStatus

 

String

Document Status

 

1. 12 .4

DocumentDescription

 

String

Document Description

 

1. 12.5

DocumentCreator

 

String

Document Creator

 

1. 12.6

DocumentBU

 

List of OrgEntity object

Document BU

 

1. 12.8

OperationName

 

String

Operation Name

 

 

DocumentBU

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1. 12.6.1

EntityCode

 

String

Entity Code

 

1. 12.6.2

IsDefault

 

Boolean

Is Default

 

1. 12.6.3

EntityType

 

String

Entity Type

 

1. 12.6.4

LOBEntityCode

 

String

LOB Entity Code (Line of business)

 

 

ERRORDETAILS

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

3.1

Key

 

String

Key

 

3.2

Errors

 

List of Errors

Errors

 

 

ERRORS

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

3.2.1

ErrorCode

 

String

ErrorCode

 

3.2.2

ErrorDescription

 

String

ErrorDescription

 

 

SUCCESS DETAILS

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

4.1

Key

 

String (100)

Key