heilog.ch.Api

<back to all web services

GetAllUsersRequest

The following routes are available for this service:
GET/users
GetAllUsersRequest Parameters:
NameParameterData TypeRequiredDescription
CompanyOrEmailquerystringNo
RolequerystringNo
UserStatequeryUserState?No
LabelTemplateIdquerylong?No
LabelVersionqueryLabelVersion?No
PageSizequeryintNo
PagequeryintNo
PropertyquerystringNo
IsAscendingqueryboolNo
UserState Enum:
NameValue
Active1
Inactive2
Locked3
LabelVersion Enum:
NameValue
PrimeraLogo1
PrimeraLogoBarcode2
PrimeraNaturdrogerieBern3
PrimeraStuder4
Zebra5
ZebraBaumannRichterswil6
ZebraSonderegger7
ZebraSwidroArialLogo8
ZebraSwidroArialLogoBarcode9
ZebraLogo11
ZebraLogoBarcode12
PrimeraFuernitz13
PrimeraImlig14
PrimeraImligNaturheil15
Primera7616
RaegebogeWinterthur17
ZebraKraemer18
ZebraBoznerplatz19
ZebraPinzgau20
ZebraRoggen21
ZebraStandardLogo22
ZebraStandardLogoEAN1323
ZebraStandardNoLogo24
ZebraWalgau26
ZebraFrLogo27
ZebraKuettigen29
GetAllUsersResponse Parameters:
NameParameterData TypeRequiredDescription
UsersformList<UserListItemDto>No
TotalEntitiesformlongNo
PageformintNo
PropertyformstringNo
IsAscendingformboolNo
PageSizeformintNo
UserListItemDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
CompanyformstringNo
AddressformstringNo
CityformstringNo
EmailformstringNo
LockedDateformDateTime?No
IsActiveformboolNo
RoleformstringNo
PermissionformstringNo

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 /users HTTP/1.1 
Host: heidak-api.test.exanic.ch 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	users: 
	[
		{
			id: 0,
			company: String,
			address: String,
			city: String,
			email: String,
			lockedDate: 0001-01-01,
			isActive: False,
			role: String,
			permission: String
		}
	],
	totalEntities: 0,
	page: 0,
	property: String,
	isAscending: False,
	pageSize: 0
}