GetAllPersonaAndRoles (GET) | GEP TECH DOCUMENTATION

Overview

This GET API can be used to retrieve contact persona and role details in GEP SMART to post them into ERP.

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

Request

https://<Instance>/SmartInterfaceAPI/api/Contact/PersonaAndRoles

Response

{
  "data": [
    {
      "personaName": "String",
      "personaCode": "String",
      "activities": [
        {
          "code": "String",
          "name": "String",
          "description": "String"
        }
      ],
      "personaDescription": "String"
    }
  ],
  "statusCode": "String",
  "errorDetails": [
    {
      "key": "String",
      "errors": [
        {
          "errorCode": "string",
          "errorDescription": "string"
        }
      ]
    }
  ],
  "successDetails": [
    {
      "key": "String"
    }
  ]
}

Examples

Success Scenario - Request

https://<Instance>/SmartInterfaceAPI/api/Contact/PersonaAndRoles

Success Scenario – Response

{
  "data": [
    {
      "personaName": " Admin ",
      "personaCode": "21",
      "activities": [
        {
          "code": " 21600005 ",
          "name": " Allow Buyer to Acknowledge Order ",
          "description": " Enables Buyer to Acknowledge Purchase Order "
        }
      ],
      "personaDescription": "Have complete administration capabilities"
    }
  ],
  "statusCode": "200",
  "errorDetails": [],
  "successDetails": []
}

Data Elements

	Get All Persona and Roles
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1	Data		List of PersonaAndRoles 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	PersonaName		String	Name of the entity
1.2	PersonaCode		String	Persona Code of the entity
1.3	Activities		List of UserActivity object	Check data type UserActivity for details
1.4	PersonaDescription		String	Persona Description of entity

	Activities
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.3.1	Code		String	Code of the entity
1.3.2	Name		String	Name of the entity
1.3.3	Description		String	Description of the entity

	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