API Docs. Elcoin Ltd

oAuth. Fetch role by request POST

# ENDPOINT

/api/oAuthRepresentativeRole/getData/oAuthRepresentativeRoleSearchRequest

# REQUEST arguments

Variable	Value	Example	Usage	Description
X-App-Sig header 0			M

# REQUEST BODY

# RESPONSE

# REQUEST arguments

Variable	Name	Type	Format	Usage	Description
X-App-Sig	X-App-Sig	header	string	M

# REQUEST BODY

Schema: oAuthRepresentativeRoleSearchRequest

Type: object

Variable	Name	Type	Description
client_code	Client code	string	Unique client identifier. Issued automatically by the System upon new Customer registration.
representative_client_code	representative_client_code	string
representative_or_client_code	Representative or client code	string
role	role	string	List of allowed values in field (value=>name): 0 ACCESS:DEVICE:MODIFY 1 ACCESS:DEVICE:VIEW 2 ACCOUNT:ANY:MODIFY 3 ACCOUNT:ANY:VIEW 4 APPLICATION:ANY:MODIFY 5 APPLICATION:ANY:VIEW 6 COUNTERPARTY:ANY:MODIFY 7 COUNTERPARTY:ANY:VIEW 8 CUSTOMER:DIRECT_DEBIT:MODIFY 9 CUSTOMER:DIRECT_DEBIT:VIEW 10 MESSAGE:ANY:MODIFY 11 MESSAGE:ANY:VIEW 12 OWNER 13 PAYMENT:ANY:AUTHORIZE 14 PAYMENT:ANY:MODIFY 15 PAYMENT:ANY:VIEW 16 PAYMENT:CONVERTATION:MODIFY 17 PAYMENT:CONVERTATION:VIEW 18 PROFILE:ANY:MODIFY 19 PROFILE:ANY:VIEW

# REQUEST BODY EXAMPLE

							{   "source_system":"IB",
    "client_code":"EN00000CY",
    "representative_client_code":"",
    "representative_status":"",
    "role":""
}

# POSITIVE RESPONSE

getData oAuthRepresentativeRoleSearchRequest

Schema: oAuthRepresentativeRole

Type: application/json

Variable	Name	Type	Description
status	status	string	Request execution status
error_description	Error Description	string	Description of error
error	Error Code	string	Error code
data_type	data_type	string	Type of data
total_records	total_records	string	Total count of records
data	data	array	data of Response

attribute: data

Variable	Name	Type	Format	Description
action	Action	string
activation_date	Activation Date	string	DATE	Activation date in the system
client_code	Client code	string		Unique client identifier. Issued automatically by the System upon new Customer registration.
create_date	Create Date	string	DATETIME	The date entry was created on
create_user	Create User	string		The username of ABS user who has created an entry
expiration_date	Expiration Date	string	DATE	Expiration date in the system
form_title	form_title	string		Service field
id	id	integer	INT64	Record's sequence number generated in the system.
modify_date	Modify Date	string	DATETIME	The date entry was last modified on
modify_user	Modify User	string		The username of ABS user who has made last changes to the entry
representative_client_code	representative_client_code	string
resource	resource	string
role	role	string
state	state	integer	INT64	Record state for replication
uid	uid	string		Unique record identifier which is used to distinguish between existing records
version	version	integer	INT64	Record version for replication

# RESPONSE POSITIVE EXAMPLE

							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "",
    "total_records": 33,
    "data": [
        {
            "id": 286,
            "uid": "80a5d152-cb10-f5af-8014-698a38d5d706",
            "version": 4184355,
            "state": 0,
            "modify_date": "2021-05-26T22:19:44.316",
            "modify_user": "root",
            "create_date": "2021-05-26T22:19:44.310",
            "create_user": "root",
            "client_code": "EN00000CY",
            "representative_client_code": "EN0000A82",
            "role": "ACCESS:DEVICE:MODIFY",
            "resource": "",
            "activation_date": "2021-05-26",
            "expiration_date": null,
            "full_name": "AVALON LIMITED",
            "representative_full_name": "Doe Joe",
            "representative_status": "RESTRICTED",
            "representative_type": "REPRESENTATIVE",
            "representative_entity_type": "PERSON",
            "client_status": "ACTIVE"
        },
        {
            "id": 287,
            "uid": "80a5d152-cb10-f5af-8014-698a00e5fa06",
            "version": 4184357,
            "state": 0,
            "modify_date": "2021-05-26T22:19:44.324",
            "modify_user": "root",
            "create_date": "2021-05-26T22:19:44.320",
            "create_user": "root",
            "client_code": "EN00000CY",
            "representative_client_code": "EN0000A82",
            "role": "ACCOUNT:ANY:MODIFY",
            "resource": "",
            "activation_date": "2021-05-26",
            "expiration_date": null,
            "full_name": "AVALON LIMITED",
            "representative_full_name": "Doe Joe",
            "representative_status": "RESTRICTED",
            "representative_type": "REPRESENTATIVE",
            "representative_entity_type": "PERSON",
            "client_status": "ACTIVE"
        }
	]
}

# NEGATIVE RESPONSE

Schema: HeaderResponseStatusError

Type: application/json

Variable	Name	Type	Description
status	status	string	Request execution status
error_description	Error Description	string	Description of error
error	Error Code	string	Error code
data_type	data_type	string	Type of data
total_records	total_records	string	Total count of records
data	data	object	Empty object

# Other endpoints

Name	Endpoint
Fetch Access / Refresh Token	/oauth/v2/token
IB Password Restore	/oauth/v2/passwordRestore
IB Login	/oauth/v2/login
IB Challenge	/oauth/v2/challenge
IB Sign	/oauth/v2/sign
oAuth. Change password by request	/api/oAuthSecurity/changePassword/oAuthChangePasswordRequest
oAuth. Fetch device by request	/api/oAuthDevice/getData/oAuthDeviceSearchRequest
oAuth. Create/update device	/model/oAuthDevice/putDb
oAuth. Set device status by Request	/api/oAuthDevice/setDeviceStatus/oAuthDeviceStatusRequest
IB Password Restore Reset	/oauth/v2/passwordRestoreReset
IB Password Restore Verification	/oauth/v2/passwordRestoreVerification