GetPartnerFormDetailsByPage (GET)

Overview

This GET API can be used to retrieve partner form details from GEP SMART to post them into ERP.

URL Format: https://<Instance>/SmartInterfaceAPI/api/Partner/FormDetails
 

Request

https:///SmartInterfaceAPI/api/Partner/FormDetails ?PageNo=0&PageSize=1

Response
{
 "data":[
 {
 "formDetails":[
 {
 "formCode":0,
 "formName":"string",
 "formTypeName":"string",
 "isActive":true,
 "isDeleted":true,
 "minScore":0,
 "additionalInformation":[
 {
 "questionId":0,
 "questionText":"string",
 "questionsResponseList":[
 {
 "responseValue":"string",
 "childQuestionList":[
 null
 ],
 "columnText":"string",
 "rowId":0
 }
 ],
 "isDeleted":true
 }
 ]
 }
 ],
 "gepPartnerCode":0,
 "sourceSystemDetails":[
 {
 "name":"string",
 "value":"string"
 }
 ],
 "legalCompanyName":"string"
 }
 ],
 "statusCode":"string",
 "errorDetails":[
 {
 "key":"string",
 "errors":[
 {
 "errorCode":"string",
 "errorDescription":"string"
 }
 ]
 }
 ],
 "successDetails":[
 {
 "key":"string"
 }
 ]
}

 

Examples

Success Scenario - Request

https://<Instance>/SmartInterfaceAPI/api/Partner/FormDetails ?PageNo=0&PageSize=1

 

Success Scenario – Response

{
   "data":[
      {
         "formDetails":[
            {
               "formCode":1,
               "formName":"Primary Registration Form",
               "formTypeName":"Primary Registration Form",
               "isActive":true,
               "isDeleted":false,
               "minScore":0.0000000000,
               "additionalInformation":[
                  {
                     "questionId":25096,
                     "questionText":"Is the Vendor a publicly traded company or a subsidiary or affiliate of a publicly traded company?",
                     "questionsResponseList":[
                        {
                           "responseValue":"No",
                           "childQuestionList":null,
                           "columnText":null,
                           "rowId":0
                        }
                     ],
                     "isDeleted":false
                  },
                  {
                     "questionId":25101,
                     "questionText":"Does a public official have more than a 10% ownership interest in the Vendor?",
                     "questionsResponseList":[
                        {
                           "responseValue":"No",
                           "childQuestionList":null,
                           "columnText":null,
                           "rowId":0
                        }
                     ],
                     "isDeleted":false
                  },
                  {
                     "questionId":25118,
                     "questionText":"Is any Public Official an officer or director of the Vendor?",
                     "questionsResponseList":[
                        {
                           "responseValue":"No",
                           "childQuestionList":null,
                           "columnText":null,
                           "rowId":0
                        }
                     ],
                     "isDeleted":false
                  },
                  {
                     "questionId":25100,
                     "questionText":"Will any non-employee broker, agent, or representative working on behalf of the Vendor be compensated for the Vendor's relationship with Exelon?",
                     "questionsResponseList":[
                        {
                           "responseValue":"No",
                           "childQuestionList":null,
                           "columnText":null,
                           "rowId":0
                        }
                     ],
                     "isDeleted":false
                  },
                  {
                     "questionId":25103,
                     "questionText":"Will the Vendor’s work with Exelon result in compensation to one or more of the following for either (a) obtaining Exelon’s business for the Vendor (for example, through a commission, sales incentive, or similar arrangement), or (b) playing a senior role in managing the delivery of the Vendor’s goods or services to Exelon (for example, as Exelon’s customer relationship manager or the project manager for a large project)?",
                     "questionsResponseList":[
                        {
                           "responseValue":"None of the above",
                           "childQuestionList":null,
                           "columnText":null,
                           "rowId":0
                        }
                     ],
                     "isDeleted":false
                  },
                  {
                     "questionId":25153,
                     "questionText":"Please provide the name and contact information of the Vendor employee who submitted answers to this Vendor Affiliation Questionnaire.",
                     "questionsResponseList":[
                        {
                           "responseValue":"Test NV Apr 21 2021, Senior Business Analyst",
                           "childQuestionList":null,
                           "columnText":null,
                           "rowId":0
                        }
                     ],
                     "isDeleted":false
                  }
               ]
            }
         ],
         "gepPartnerCode":431376,
         "sourceSystemDetails":[
            {
               "name":"Client Supplier code",
               "value":"PC-2017.105966"
            }
         ],
         "legalCompanyName":"Testint1"
      }
   ],
   "statusCode":"200",
   "errorDetails":[
      
   ],
   "successDetails":[
      
   ]
}

 

Data Elements

Get Partner Form Details By Page

Property

Required?

Data type

Description

Validations / Exceptions

Data

 

List of Partner Form object

Partner Form is an object in partner form details

 

StatusCode

 

String

It’s a status code

 

ErrorDetails

 

List of ErrorModel object

Error model object

 

SuccessDetails

 

List of SuccessModel object

Success model object

 

Data

Property

Required?

Data type

Description

Validations / Exceptions

FormCode

 

Long

Unique ID for partner form code in GEP System

 

FormName

 

String(200)

Form name If any

 

FormTypeName

 

String(200)

Form type name like (eg:- Additional Form, Primary Registration Form)

 

IsActive

 

Bool

Status of form if active or not

 

IsDeleted

 

Bool

Visibility status of the form if visible on the application platform or not

 

MinScore

 

Long

MinScore given to form

 

AdditionalInformation

 

List of Question object

An array of questions and their responses, that are available in the partner profile

 

This field is available only on Outbound not on Inbound

Check Data Type Question for details

 

GepPartnerCode

 

Long

Unique ID for this Partner in GEP systems

 

This field is available only on Outbound not on Inbound

 

SourceSystemDetails

 

List of SourceSystemDetails object

An array of strings that contain information on source systems of partner data

 

LegalCompanyName

 

string

Parent company Name based on parent partner code

 

AdditionalInformation

Property

Required?

Data type

Description

Validations / Exceptions

QuestionId

 

Long

Id of question

 

QuestionText

 

String

Text of the question

 

QuestionsResponseList

 

List of QuestionResponse object

An array of question response

 

IsDeleted

 

Boolean

Status of the entity if they are to be visible or not, on the application

 

QuestionsResponseList

Property

Required?

Data type

Description

Validations / Exceptions

ResponseValue

 

String

Response value

 

ChildQuestionList

 

List of question object

 

 

ColumnText

 

String

Column text

 

RowId

 

Long

Row id

 

ErrorDetails

Property

Required?

Data type

Description

Validations / Exceptions

Key

 

String

Key in error details

 

Errors

 

List of Error object

Error in error details

 

Errors

Property

Required?

Data type

Description

Validations / Exceptions

ErrorCode

 

String

Code in errors

 

ErrorDescription

 

String

Description in errors

 

SuccessDetails

Property

Required?

Data type

Description

Validations / Exceptions

Key

 

String

Key in success details