API - Get Account Groups

Purpose

A post API to get a list of account groups.

Accessing the API

XML
Endpoint: /API/APP/APP007/GetAccountGroups

HTTP METHOD

XML
POST


Parameters

Parameters

Data Type

Required

Description

Filter

String

YES

All/Active/Disabled

Instance

String

YES

 Instance name


Sample Request (JSON)

XML
{
   "Filter":"All/Active/Disabled",
   "Instance":"Instance name",
}

Sample Response (JSON)

XML
{
	“Version”:”6.0.0.0”,
	"IsSuccess":true,
	"LogCode":"0",
"Result":
{
     [
     "GroupName":"String",
     "Description":"String",
     "RequiredTicketNo":"String",
     "AllowAccessViaAPI":"String",
     "EnforceComment":"String",
     "CommentMinLength":"String",
     "Method":"String",
     "Attributes":
	 [
		"Attribute":"String",
		"Operator":"String 
		"Input":"String",
                    ]
     ]
},
     "CreatedBy":"String",
     "CreatedOn":"String",
     "Instance":"String",
     "Status":"String",
},
	"StatusCode":"Accepted",
	"Timestamp":"03 Jun 2019 12:20:10 GMT 05:30:00"
}

Error Code

Error Description

011649

Current user do not have permission to take an action

011651

The authorization header is either empty or not basic

011673

Invalid credentials

011674

Invalid credentials

011675

Unable to validate request

011683

Invalid instance name

011803

Unable to insert API log details