GetContactByContactCode (GET) | GEP TECH DOCUMENTATION

Download

Overview

This GET API can be used to retrieve contact details by contact code details in GEP SMART to post them into ERP.

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

Request

ContactCode is a mandatory attribute for this API call:

https://<Instance>/SmartInterfaceAPI/api/Contact/ContactCodes?ContactCodes=CM_ContactCode_2

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

https://<Instance>/SmartInterfaceAPI/api/Contact/ContactCodes?ContactCodes=CM_ContactCode_2

Success Scenario – Response

{
  "data": [
    {
      "gepContactCode": 0,
      "userName": "Avian_test2@gep.com",
      "contactCode": "CM_ContactCode_2",
      "managerCode": [
        ""
      ],
      "address": {
        "addressLine1": "Smith Villa",
        "addressLine2": "thane belapur road",
        "addressLine3": "78",
        "city": "thane",
        "stateCode": "TX",
        "stateOther": "Texas",
        "countryCode": "US",
        "zipCode": "",
        "faxNo": "233-900-0898",
        "phoneNo": "61372100",
        "phoneOther": "233-900-4567",
        "phoneExtension": "1234",
        "phoneOtherExtension": "4556",
        "county": "blast county"
      },
      "firstName": "FNameMN-1",
      "lastName": "LNameMN-1",
      "emailAddress": "pg1@gep.com",
      "authorityAmt": 1,
      "isActive": false,
      "isDeleted": false,
      "userActivities": [
        {
          "activityName": 10100001,
          "userActivity": null
        }
      ],
      "timeZone": "Eastern Standard Time",
      "locationCode": null,
      "currencyCode": "USD",
      "designation": "new",
      "commitmentAmount": 6000,
      "orgEntities": null,
      "categories": [
        {
          "pasCode": 476350000425,
          "isDefault": true,
          "clientPasCode": ""
        }
      ],
      "regions": [
        {
          "regionName": "Americas",
          "isDefault": false
        }
      ],
      "lastLoginDate": "2019-10-16T02:30:55",
      "personaAndRoles": {
        "personaName": "UnAssigned",
        "personaCode": "588",
        "activities": [
          {
            "code": "10100001",
            "name": "Administration"
          }
        ],
        "personaDescription": "To be mapped to all the users who are yet to be on boarded."
      },
      "customFields": null,
      "contactManagers": [
        {
          "managerCode": "",
          "managerType": null
        }
      ]
    }
  ],
  "statusCode": "200",
  "errorDetails": [],
  "successDetails": [
    {
      "key": "CM_ContactCode_2"
    }
  ]
}

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	AmendmentAuthorizeAmountForContract		Decimal	Amendment Authorize Amount for Contract
1.2	SecondaryAuthorizeAmountForContract		Decimal	Secondary Authorize Amount for Contract
1.3	SecondaryAuthorizeAmount		Decimal	Secondary Authorize Amount
1.4	AuthorizeAmountForProject		Decimal	Authorize Amount for Project
1.5	CultureCode		String	Culture Code
1.6	SSOType		Int	SSO Type
1.7	CustomFields		List of CustomField object	Check Data Type CustomFields for details
1.8	PersonaAndRoles		PersonaAndRoles object	Check Data Type PersonaAndDetails for details
1.9	LastLoginDate		Datetime
1.10	Regions		List of Region object	Check Data Type Regions for details
1.11	Categories		List of PAS object	Check Data Type PAS for details
1.12	ContactOrgDetails		List of ContactOrgDetails object	Check Data Type ContactDetails for details
1.13	AccountingEntities		List of OrgEntity object	Check Data Type OrgEntity for details
1.14	OrgEntities		List of OrgEntity object	Check Data Type OrgEntity for details
1.15	CommitmentAmount		Decimal	Commitment Amount of the entity
1.16	Designation		String	Designation of the entity
1.17	CurrencyCode		String	Currency Code of the entity
1.18	GEPContactCode		Long	GEP Contact Code
1.19	UserName		String	User Name of entity
1.20	ContactCode		String	Contact Code
1.21	ManagerCode		List of String	Manager Code
1.22	Address		Address object	Check Data Type Address for details
1.23	FirstName		String	First Name of the entity
1.24	WorkGroup		String
1.25	LastName		String	Last Name of the entity
1.26	AuthorityAmt		Decimal	Authority Amount of the entity
1.27	IsActive		Boolean	Status of the entity if they are active or not
1.28	IsDeleted		Boolean	Status of the entity if they are to be visible or not on the application
1.29	UserActivities		List of Activity object	Check Data Type Activity for details
1.30	TimeZone		String	Time Zone of the entity
1.31	LocationCode		String	Location Code of the entity
1.32	EmailAddress		String	Email Address of the entity
1.33	ContactManagers		List of ContactManager object	Check Data Type ContactManager for details

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

	PersonaAndRoles
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.6.1	PersonaName		String	Name of the entity
1.6.2	PersonaCode		String	Persona Code of the entity
1.6.3	Activities		List of UserActivity object	Check data type UserActivity for details
1.6.4	PersonaDescription		String	Persona Description of entity

	Activities
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.6.3.1	Code		String	Code of the entity
1.6.3.2	Name		String	Name of the entity
1.6.3.3	Description		String	Description of the entity

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

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

	ContactOrgDetails
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.10.1	OrgEntity		OrgEntity object	Check Data Type OrgEntity for details
1.10.2	PersonaAndRoles		PersonaAndRoles object	Check Data Type PersonaAndDetails for details
1.10.3	LOBType		String	LOB Type of entity
1.10.4	IsDefaultLOB		Boolean	Status of the entity if this is default LOB or not

	OrgEntity
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.10.1.1	EntityCode		String	Entity Code of entity
1.10.1.2	IsDefault		Boolean	Status of the entity if this is default or not
1.10.1.3	EntityType		String	Entity Type of entity
1.10.1.4	LOBEntityCode		String	LOB Entity Code of entity

	Address
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.22.1	POBoxNumber		String
1.22.2	County		String	County of the address
1.22.3	PhoneOtherExtension		String	Phone 2’s extension of the entity
1.22.4	PhoneExtension		String	Phone extension of the entity
1.22.5	PhoneOther		String	Phone 2 of the entity
1.22.6	PhoneNo		String	Phone number of the entity
1.22.7	FaxNo		String	Fax number of the entity
1.22.8	ZipCode		String	Zip code of the entity
1.22.9	CountryCode		String	Country code of the entity
1.22.10	StateOther		String	State name (in case of others) of the entity
1.22.11	StateCode		String	State code of the entity
1.22.12	City		String	City of the entity
1.22.13	AddressLine3		Sting	Address line 3 of the entity
1.22.14	AddressLine2		String	Address line 2 of the entity
1.22.15	AddressLine1		String	Address line 1 of the entity

UserActivities

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.29.1

ActivityName

Activities Enum

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

	ContactManagers
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.33.1	ManagerCode		String
1.33.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