Net3 API Interface for Customer Portal

<back to all web services

CompanyUsers

Retrieve Users for a Company.

Requires Authentication
The following routes are available for this service:
GET/company/{companyId}/usersGet Users by CompanyId
CompanyUsers Parameters:
NameParameterData TypeRequiredDescription
companyIdpathGuidNo
CompanyUsersResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<TypeUser>No
ResponseStatusformResponseStatusNo
TypeUser Parameters:
NameParameterData TypeRequiredDescription
UserIdformGuidNo
FirstNameformstringNo
LastNameformstringNo
EmailformstringNo
FullNameformstringNo
IsActiveformboolNo
CompanyIdformGuid?No
RolesformstringNo
IdformstringNo

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 /company/{companyId}/users HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	[
		{
			userId: 00000000000000000000000000000000,
			firstName: String,
			lastName: String,
			email: String,
			fullName: String,
			isActive: False,
			companyId: 00000000000000000000000000000000,
			roles: String,
			id: String
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}