DownloadThis POST API can be used to capture license info details from ERP into GEP SMART, which can be used as a reference in P2P transactions.
URL Format: https://<Instance>/SmartInterfaceAPI/api/Partner/LicenseInfo
[
{
"gepPartnerCode": 0,
"partnerCode": "string",
"companyOverview":
{
"newROCId": "string",
"oldROCId": "string",
"companyName": "string",
"bumiputeraStatus": "string",
"localityStatus": "string",
"licenseAttachment":
{
"attachmentNameWithExtn": "string",
"attachmentData": "string",
}
},
"fillLicenseRegistration":
{
"licenseStatus": "string",
"licenseStartDate": "2020-07-27T11:01:29.947z",
"licenseEndDate": "2020-07-27T11:01:29.947z",
"applicableforUpstream": "string,
"applicableforDownstream": "string
"licenseAttachment":
{
"attachmentNameWithExtn": "string",
"attachmentData": "string",
}
},
"specialLicense":
{
"specialLicenseStatus": "string",
"licenseAttachment":
{
"attachmentNameWithExtn": "string",
"attachmentData": "string",
}
}
}
]
{
"data": null,
"statusCode": "string",
"errorDetails": [
{
"key": "string",
"errors": [
{
"errorCode": "string",
"errorDescription": "string"
}
]
}
],
"successDetails": [
{
"key": "string"
}
]
}
Success Scenario – Request
Below request only contains the mandatory attributes:
[
{
"PartnerCode": "PC-SAY-Test",
"gepPartnerCode": 0,
"CompanyOverview": [
{
"newROCId": "sskh",
"oldROCId": "ffs87",
"CompanyName": "Amazon",
"bumiputeraStatus": "sskhBumiStatus",
"localityStatus": "ffs87LocalityStatus",
"licenseAttachmen": [
{
"AttachmentNameData": Base64FormatData,
"AttachmentNameWithExtn": "94050"
}]
}
] ,
"FullRegistrationLicense": [
{
"licenseStatus": "sskh",
"licenseStartDate": "2020-07-27T11:01:29.947z ",
"licenseEndDate": "2020-07-30T11:01:29.947z ",
"applicableforUpstream": "ffs87applicableforUpStream",
"applicableforDownstream": "ffs87applicableforDownStream",
"licenseAttachmen": [
{
"AttachmentNameData": Base64FormatData,
"AttachmentNameWithExtn": "94050"
}]
}
] ,
"specialLicense": [
{
"specialLicenseStatus": "sskhspecialLicenseStatus",
"licenseAttachmen": [
{
"AttachmentNameData": Base64FormatData,
"AttachmentNameWithExtn": "94050"
}]
}
]
}
]
Success Scenario – Response
{
"data": null,
"statusCode": "200",
"errorDetails": [],
"successDetails": [
{
"key": "PC-SAY-Test"
}
]
}
Error Scenario – Request
Below request contains a missing value of the Data Validation attribute – applicableforUpstream:
[
{
"PartnerCode": "PC-SAY-Test",
"gepPartnerCode": 0,
"CompanyOverview": [
{
"newROCId": "sskh",
"oldROCId": "ffs87",
"CompanyName": "Amazon",
"bumiputeraStatus": frbumiputerastatus",
"localityStatus": "ffs87LocalityStatus",
"licenseAttachmen": [
{
"AttachmentNameData": Base64FormatData,
"AttachmentNameWithExtn": "94050"
}]
}
] ,
"FullRegistrationLicense": [
{
"licenseStatus": "sskh",
"licenseStartDate": "2020-07-27T11:01:29.947z ",
"licenseEndDate": "2020-07-30T11:01:29.947z ",
"applicableforUpstream": "xxxxx",
"applicableforDownstream": "ffs87applicableforDownStream",
"licenseAttachmen": [
{
"AttachmentNameData": Base64FormatData,
"AttachmentNameWithExtn": "94050"
}]
}
]
]
Error Scenario – Response
{
"data": null,
"statusCode": "400",
"errorDetails": [
{
"key": "PC-SAY-Test",
"errors": [
{
"errorCode": "DataValidation",
"errorDescription": "Invalid value in ApplicableforUpstream xxxxx."
}
]
}
],
"successDetails": []
}
|
LicenseAttachment |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
AttachmentNameData |
No |
Base 64 |
file converted data in base 64 |
Max length for SpecialLicenseStatus is 500 |
|
AttachmentNameWithExtn |
No |
String (500) |
File name |
Std file format name validation |
|
Special License |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
SpecialLicenseStatus |
No |
String (500) |
SpecialLicenseStatus |
Max length for SpecialLicenseStatus is 500 |
|
LicenseAttachment |
No |
List |
List of company overview attachment details |
|
|
Full Registration License Details |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
LicenseStatus |
No |
String (500) |
New roc id |
Max length for NewROCId is 500 |
|
LicenseStartDate |
No |
Date |
Check start date data |
Std date validation Date should be less than or equal to current date and less than end date validation |
|
LicenseEndDate |
No |
Date |
Check end date data |
End date should be future dateStd date validation |
|
ApplicableforUpstream |
No |
String (500) |
Check data ApplicableforUpstream |
Max length for ApplicableforUpstream is 500 Validate with master table data |
|
ApplicableforDownstream |
No |
String (500) |
Check data ApplicableforDownstream |
Max length for ApplicableforDownstream is 500. |
|
LicenseAttachment |
No |
List |
List of company overview attachment details |
|
|
CompanyOverview |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
NewROCId |
No |
String (500) |
New roc id |
Max length for NewROCId is 500 |
|
OldROCId |
No |
String (500) |
Old roc id |
Max length for OldROCId is 500 |
|
CompanyName |
No |
String (500) |
Company Name |
Max length for CompanyName is 500 |
|
BumiputeraStatus |
No |
String (500) |
Check data BumiputeraStatus |
Max length for BumiputeraStatus is 500 Validate with master table data |
|
LocalityStatus |
No |
String (500) |
Check data LocalityStatus |
Max length for LocalityStatus is 500. Validate with master table data |
|
LicenseAttachment |
No |
List |
List of company overview attachment details |
|
|
Partner |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
PartnerCode |
Yes |
String(100) |
Note: Client Partner Code must be unique from the <CLIENT NAME> systems, so if there are duplicates within the service layer, the SSID will have to be appended to the Client Partner Code, and the resulting value will be ClientPartnerCode-SSID |
Partnercode is mandatory. Max length for PartnerCode is 100. |
|
GEPPartnerCode |
No |
Long |
Unique ID for this Partner in GEP systems
This field is available only on Outbound not on Inbound |
|
|
CompanyOverview |
No |
String (20) |
Dun & Brad number of the partner |
Max length for DunAndBradNumber is 20 Allow only Numeric value |
|
FullLicenseRegistration |
No |
String (30) |
A string used to identify the partner |
Max length for CompanyIdentification is 30 |
|
SpecialLicense |
No |
Int |
The year of establishment of the partner |
|