SmartAcc DynaMod Web API v2024.4 Build 0000 - Local

<back to all web services

CustomerGroups

Customer Module

Customer Groups API

Requires Authentication
Required permission:CustomerGroup-Setup.GET
The following routes are available for this service:
GET/CustomerGroups
GET/CustomerGroups/page/{Page}Get records by given a page numberEach page consists of 20 records
GET/CustomerGroups/AcCusGroupID/{AcCusGroupID}Get records for given ID
CustomerGroups Parameters:
NameParameterData TypeRequiredDescription
Pagepathint?NoPage Number. Default 1.
RecordsPerPagequeryint?NoRecords Per Page. Default 20 Records.
AcCusGroupIDpathstringNo
CustomerGroupsResponse Parameters:
NameParameterData TypeRequiredDescription
CustomerGroupsformList<AcCusGroup>No
ResponseStatusformResponseStatusNo
TotalRecordsformintNoTotal records in all pages.
TotalRecordsInPageformintNoTotal records in current page.
AcCusGroup Parameters:
NameParameterData TypeRequiredDescription
AcCusGroupIDformstringYesCustomer Group ID
AcCusGroupDescformstringYesDescription
CreateByformstringNo
CreateDateformDateTimeNo
EditByformstringNo
EditDateformDateTimeNo
StampformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /CustomerGroups HTTP/1.1 
Host: snr2u.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CustomerGroups: 
	[
		{
			AcCusGroupID: String,
			AcCusGroupDesc: String,
			CreateBy: String,
			CreateDate: 0001-01-01,
			EditBy: String,
			EditDate: 0001-01-01,
			Stamp: 0
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	TotalRecords: 0,
	TotalRecordsInPage: 0
}