GetAllContactsByPersonas (POST) | GEP TECH DOCUMENTATION

Overview

This POST API can be used to capture new additions in contact details from ERP into GEP SMART, that can be used as reference in P2P transactions.

URL Format: https://<Instance>/SmartInterfaceAPI/api/Contact/ContactByPersonas

Request

{
   "personas": [
      {
         "personaName": "String",
         "personaCode": "String",
         "activities": [
            {
               "code": "String",
               "name": "String",
               "description": "String"
            }
         ],
         "personaDescription": "String"
      }
   ],
   "pageNo": 0,
   "pageSize": 0
}

Response

{
   "data": [
{
   "gepContactCode": 0,
   "userName": "string",
   "contactCode": "string",
   "managerCode": [
      "string"
   ],
   "address": {
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "city": "string",
      "stateCode": "string",
      "stateOther": "string",
      "countryCode": "string",
      "zipCode": "string",
      "faxNo": "string",
      "phoneNo": "string",
      "phoneOther": "string",
      "phoneExtension": "string",
      "phoneOtherExtension": "string",
      "county": "string",
      "poBoxNumber": "string"
   },
   "firstName": "string",
   "lastName": "string",
   "emailAddress": "string",
   "authorityAmt": 0,
   "isActive": true,
   "isDeleted": true,
   "userActivities": [
      {
         "activityName": "NONE"
      }
   ],
   "timeZone": "string",
   "locationCode": "string",
   "currencyCode": "string",
   "designation": "string",
   "commitmentAmount": 0,
   "orgEntities": [
      {
         "entityCode": "string",
         "isDefault": true,
         "entityType": "string",
         "lobEntityCode": "string"
      }
   ],
   "accountingEntities": [
      {
         "entityCode": "string",
         "isDefault": true,
         "entityType": "string",
         "lobEntityCode": "string"
      }
   ],
   "contactOrgDetails": [
      {
         "orgEntity": {
            "entityCode": "string",
            "isDefault": true,
            "entityType": "string",
            "lobEntityCode": "string"
         },
         "personaAndRoles": {
            "personaName": "string",
            "personaCode": "string",
            "activities": [
               {
                  "code": "string",
                  "name": "string",
                  "description": "string"
               }
            ],
            "personaDescription": "string"
         },
         "lobType": "string",
         "isDefaultLOB": true
      }
   ],
   "categories": [
      {
         "pasCode": 0,
         "isDefault": true,
         "clientPasCode": "string",
         "isDeleted": true
      }
   ],
   "regions": [
      {
         "regionName": "string",
         "isDefault": true
      }
   ],
   "lastLoginDate": "2020-01-21T11:53:45.057Z",
   "personaAndRoles": {
      "personaName": "string",
      "personaCode": "string",
      "activities": [
         {
            "code": "string",
            "name": "string",
            "description": "string"
         }
      ],
      "personaDescription": "string"
   },
   "customFields": [
      {
         "key": "string",
         "value": [
            "string"
         ],
         "subCustomField": [
            null
         ]
      }
   ],
   "ssoType": 0,
   "cultureCode": "string",
   "authorizeAmountForProject": 0,
   "secondaryAuthorizeAmount": 0,
   "secondaryAuthorizeAmountForContract": 0,
   "amendmentAuthorizeAmountForContract": 0,
   "workGroup": "string",
   "contactManagers": [
      {
         "managerCode": "string",
         "managerType": "string"
      }
   ],
   "authorityAmountDetails": [
      {
         "documentType": "string",
         "lobType": "string",
         "lobEntityCode": "string",
         "entityType": "string",
         "entityCode": "string",
         "isDeleted": true,
         "amountAttributes": [
            {
               "amountCode": "string",
               "amount": 0
            }
         ]
      }
   ],
   "statusCode": " String ",
   "errorDetails": [
      {
         "key": "string",
         "errors": [
            {
               "errorCode": "string",
               "errorDescription": "string"
            }
         ]
      }
   ],
   "successDetails": [
      {
         "key": "String"
      }
   ]
}

Examples

Success Scenario - Request
Request below describes that this contains only the mandatory attributes:

{
   "personas": [
      {
         "personaName": "Admin",
         "personaCode": "21",
         "activities": [
            {
               "code": "21600005",
               "name": "Allow Buyer to Acknowledge Order",
               "description": "Enables Buyer to Acknowledge Purchase Order"
            }
         ],
         "personaDescription": "Users linked to this persona have complete administration capabilities for the platform including User creation, Product Settings, Global configuration, Email log and Company structure"
      }
   ],
   "pageNo": 2,
   "pageSize": 2
}

Success Scenario - Response

{
   "data": [
      {
         "gepContactCode": 0,
         "userName": "uscp1m08",
         "contactCode": "USCP1M08",
         "managerCode": [
            "USKSAW04"
         ],
         "address": {
            "addressLine1": "PO Box 8881011",
            "addressLine2": " Gigaplex ",
            "addressLine3": " Airoli ",
            "city": " Grand Rapids",
            "stateCode": "MI",
            "stateOther": " Texas ",
            "countryCode": "US",
            "zipCode": " 49588",
            "faxNo": "2358964178",
            "phoneNo": "9873215975",
            "phoneOther": "9517534562",
            "phoneExtension": "0131",
            "phoneOtherExtension": "0136",
            "county": "US",
            "poBoxNumber": "0136"
         },
         "firstName": "Prajakta",
         "lastName": "Mahajan",
         "emailAddress": "123@gep.com",
         "authorityAmt": 0,
         "isActive": false,
         "isDeleted": false,
         "userActivities": [
            {
               "activityName": "HOME"
            }
         ],
         "timeZone": "Central Standard Time",
         "locationCode": null,
         "currencyCode": "USD",
         "designation": "",
         "commitmentAmount": 0,
         "orgEntities": [
            {
               "entityCode": "0010",
               "isDefault": true,
               "entityType": "Company Code",
               "lobEntityCode": "KAP-SAP"
            }
         ],
         "categories": [
            {
               "pasCode": 476350000425,
               "isDefault": true,
               "clientPasCode": ""
            }
         ],
         "regions": [
            {
               "regionName": "Asia",
               "isDefault": false
            }
         ],
         "lastLoginDate": "2018-12-26T20:37:32",
         "personaAndRoles": {
            "personaName": "UnAssigned",
            "personaCode": "588",
            "activities": [
               {
                  "code": "10100002",
                  "name": "Home"
               }
            ],
            "personaDescription": "To be mapped to all the users who are yet to be on boarded."
         },
         "customFields": null,
         "ssoType": 2,
         "contactManagers": [
            {
               "managerCode": "USKSAW04",
               "managerType": null
            }
         ]
      }
   ],
   "statusCode": "200",
   "errorDetails": [],
   "successDetails": [
      {
         "key": "21"
      }
   ]
}

Error Scenario - Request
Request below describes that this has invalid persona code:

{
   "personas": [
      {
         "personaName": "Admin",
         "personaCode": "100",
         "activities": [
            {
               "code": "21600005",
               "name": "Allow Buyer to Acknowledge Order",
               "description": "Enables Buyer to Acknowledge Purchase Order"
            }
         ],
         "personaDescription": "Users linked to this persona have complete administration capabilities for the platform including User creation, Product Settings, Global configuration, Email log and Company structure"
      }
   ],
   "pageNo": 2,
   "pageSize": 2
}

Error Scenario – Response

{
   "data": [],
   "statusCode": "400",
   "errorDetails": [
      {
         "key": "100",
         "errors": [
            {
               "errorCode": "DataValidation",
               "errorDescription": "Invalid Persona Code"
            }
         ]
      }
   ],
   "successDetails": []
}

Data Elements

	Get all Contacts by Personas
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1	Data		List of BuyerContact object
2	StatusCode		String
3	ErrorDetails		List of ErrorModel object
4	SuccessDetails		List of SuccessModel object

	Data
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.1	ContactCode		String	Contact Code
1.2	UserName		String	User Name of entity
1.3	FirstName		String	First Name of the entity
1.4	LastName		String	Last Name of the entity
1.5	EmailAddress		String	Email Address of the entity
1.6	Address		List of Address object	Check Data Type Address for details
1.7	AuthorityAmt		Decimal	Authority Amount of the entity
1.8	IsActive		Boolean	Status of the entity if they are active or not
1.9	IsDeleted		Boolean	Status of the entity if they are to be visible or not on the application
1.10	UserActivities		List of Activity object	Check Data Type Activity for details
1.11	TimeZone		String	Time Zone of the entity
1.12	LocationCode		String	Location Code of the entity
1.13	CurrencyCode		String	Currency Code of the entity
1.14	Designation		String	Designation of the entity
1.15	CommitmentAmount		Decimal	Commitment Amount of the entity
1.16	OrgEntities		List of OrgEntity object	Check Data Type OrgEntity for details
1.17	AccountingEntities		List of OrgEntity object	Check Data Type OrgEntity for details
1.18	ContactOrgDetails		List of ContactOrgDetails object	Check Data Type ContactDetails for details
1.19	Categories		List of PAS object	Check Data Type PAS for details
1.20	Regions		List of Regions object	Check Data Type Regions for details
1.21	LastLoginDate		DateTime
1.22	PersonaAndRoles		List of PersonaAndRoles object	Check Data Type PersonaAndDetails for details
1.23	CustomFields		List of CustomFields object	Check Data Type CustomFields for details
1.24	SSOType		Int	SSO Type
1.25	CultureCode		String	Culture Code
1.26	AuthorizeAmountForProject		Decimal	Authorize Amount for Project
1.27	SecondaryAuthorizeAmount		Decimal	Secondary Authorize Amount
1.28	SecondaryAuthorizeAmountForContract		Decimal	Secondary Authorize Amount for Contract
1.29	AmendmentAuthorizeAmountForContract		Decimal	Amendment Authorize Amount for Contract
1.30	WorkGroup		String	Work Group of the entity
1.31	ContactManagers		List of ContactManager object	Check Data Type ContactManager for details
1.32	GEPContactCode		Long	GEP Contact Code of the entity This field is only available on Outbound and not on Inbound
1.33	ManagerCode		List of String	Manager Code

	Address
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.6.1	AddressLine1		String (500)	Address line 1 of the entity
1.6.2	City		String (50)	City of the entity
1.6.3	StateCode		String (10)	State code of the entity
1.6.4	CountryCode		String (2)	Country code of the entity
1.6.5	ZipCode		String (10)	Zip code of the entity
1.6.6	AddressLine2		String	Address line 2 of the entity
1.6.7	AddressLine3		String (100)	Address line 3 of the entity
1.6.8	StateOther		String	State name (in case of others) of the entity
1.6.9	FaxNo		String (20)	Fax number of the entity
1.6.10	PhoneNo		String	Phone number of the entity
1.6.11	PhoneOther		String (20)	Phone 2 of the entity
1.6.12	PhoneExtension		String	Phone extension of the entity
1.6.13	PhoneOtherExtension		String	Phone 2’s extension of the entity
1.6.14	County		String (50)	County of the address
1.6.15	PoBoxNumber		String

UserActivities

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.10.1

ActivityName

Activities Enum

One of the following values will be provided in this field; “NONE”, “ADMINISTRATION”, “HOME”, “VIEW_GEPICENTER etc.

	OrgEntities
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.16.1	EntityCode		String	Entity Code of entity
1.16.2	IsDefault		Boolean	Status of the entity if this is default or not
1.16.3	EntityType		String	Entity Type of entity
1.16.4	LOBEntityCode		String	LOB Entity Code of entity

	AccountingEntities
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.17.1	EntityCode		String	Entity Code of entity
1.17.2	IsDefault		Boolean	Status of the entity if this is default or not
1.17.3	EntityType		String	Entity Type of entity
1.17.4	LOBEntityCode		String	LOB Entity Code of entity

	ContactOrgDetails
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.18.1	OrgEntity		List of OrgEntity object	Check Data Type OrgEntity for details
1.18.2	PersonaAndRoles		List of PersonaAndRoles object	Check Data Type PersonaAndDetails for details
1.18.3	LobType		String	LOB Type of entity
1.18.4	IsDefaultLOB		Boolean	Status of the entity if this is default LOB or not

	Categories
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.19.1	PasCode		Long	PAS Code of entity
1.19.2	IsDefault		Boolean	Status of the entity if this is default or not
1.19.3	ClientPasCode		String	Client Pas Code of entity
1.19.4	IsDeleted		Boolean	Status of the entity if they are to be visible or not on the application

	Regions
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.20.1	RegionName		String	Region name of entity
1.20.2	IsDefault		Boolean	Status of the entity if this is default or not

	PersonaandRoles
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.22.1	PersonaName		String	Name of the entity
1.22.2	PersonaCode		String	Persona Code of the entity
1.22.3	Activities		List of UserActivity object	Check data type UserActivity for details
1.22.4	PersonaDescription		String	Persona Description of entity

	Activities
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.22.3.1	Code		String	Code of the entity
1.22.3.2	Name		String	Name of the entity
1.22.3.3	Description		String	Description of the entity

	CustomFields
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.23.1	Key		String	Key of the entity
1.23.2	Value		List of String	Value of the entity
1.23.3	SubCustomField		List of CustomField object	Check Data Type Custom fields for details

	ContactManagers
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.31.1	ManagerCode		String
1.31.2	ManagerType		String

	ErrorDetails
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
3.1	Key		String
3.2	Errors		List of Error object

	Errors
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
3.2.1	ErrorCode		String
3.2.2	ErrorDescription		String

	SuccessDetails
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
4.1	Key		String