Coruson API

GetUsers

Coruson Users

The following routes are available for this service:
GET	/api/users	Query for Coruson Users

**GetUsers** Parameters:
Name	Parameter	Data Type	Required	Description
PersonId	query	Guid	No	Filter by the PersonId.
Forename	query	String	No	Filter by the forename of the User.
Surname	query	String	No	Filter by the surname of the User.
FullName	query	String	No	Filter by the full name of the User.
Username	query	String	No	Filter by the username of the User.
EmailAddress	query	String	No	Filter by the email address of the User.
OrganisationalUnit	query	String	No	Filter by the name of the organisational unit the User(s) belongs to.
OrganisationalUnitId	query	Guid	No	Filter by the Id of the organisational unit the User(s) belongs to.
Group	query	String	No	Filter by the User Group the User(s) belongs to.
PersonType	query	PersonType	Yes	Filter by the type of the User. By default will return Users of all types. Allowable Values All OrganisationMember SupplierContact CustomerContact
IsActive	query	BooleanFilter	Yes	Filter by the User's status. Allowable Values All True False
OrderBy	query	UserOrder	Yes	Property to order by in Ascending order. Default is 'FullName' Allowable Values Default FullName EmailAddress OrganisationalUnit PersonType
OrderByDesc	query	UserOrder	Yes	Property to order by in Descending order. Allowable Values Default FullName EmailAddress OrganisationalUnit PersonType
ThenBy	query	UserOrder	Yes	Second Property to order by in Ascending order. NOTE: If this value is the same as either the OrderBy or OrderByDesc values, then it will be ignored. Allowable Values Default FullName EmailAddress OrganisationalUnit PersonType
ThenByDesc	query	UserOrder	Yes	Second Property to order by in Descending order. NOTE: If this value is the same as either the OrderBy or OrderByDesc values, then it will be ignored. Allowable Values Default FullName EmailAddress OrganisationalUnit PersonType

**PagingRequestBase<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Skip	form	Integer	No	Number of items to skip before returning results. Minimum suitable value is 0 and is also the default value.
Take	form	Integer	No	Number of items to return per page. Must be a number in the range 1-100. Default value is 100.
OrderBy	form	Enum	No	Order By
OrderByDesc	form	Enum	No	Order By Descending
ThenBy	form	Enum	No	Then By
ThenByDesc	form	Enum	No	Then By Descending

**RequestBase** Parameters:
Name	Parameter	Data Type	Required	Description
Version	form	int	No

**GetUsersResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Users	form	List<User>	No

**GetResponseBase** Parameters:
Name	Parameter	Data Type	Required
TotalResults	form	int	No
Skip	form	int	No
Take	form	int	No
Links	form	List<Link>	No

**ResponseBase** Parameters:
Name	Parameter	Data Type	Required	Description
StatusDescription	form	string	No
ResponseStatus	form	ResponseStatus	No

**Link** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
RequestUrl	form	string	No
Method	form	string	No

**User** Parameters:
Name	Parameter	Data Type	Required
PersonId	form	Guid	No
Forename	form	string	No
Surname	form	string	No
FullName	form	string	No
Username	form	string	No
EmailAddress	form	string	No
OrganisationalUnit	form	string	No
OrganisationalUnitId	form	Guid	No
PersonType	form	PersonType	No
IsActive	form	bool	No
UserGroups	form	List<string>	No

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.

                    POST /jsv/reply/GetUsers HTTP/1.1 
Host: platform.gaelenlighten.com 
Content-Type: text/jsv
Content-Length: length

{
	PersonId: 00000000-0000-0000-0000-000000000000,
	Skip: 0,
	Version: 0,
	Forename: String,
	Take: 0,
	Surname: String,
	FullName: String,
	Username: String,
	EmailAddress: String,
	OrganisationalUnit: String,
	OrganisationalUnitId: 00000000-0000-0000-0000-000000000000,
	Group: String,
	PersonType: All,
	IsActive: All,
	OrderBy: Default,
	OrderByDesc: Default,
	ThenBy: Default,
	ThenByDesc: Default
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Users: 
	[
		{
			Forename: String,
			Surname: String,
			Fullname: String,
			Username: String,
			EmailAddress: String,
			OrganisationalUnit: String,
			PersonType: All,
			IsActive: False,
			UserGroups: 
			[
				String
			]
		}
	],
	TotalResults: 0,
	StatusDescription: String,
	Skip: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Take: 0,
	Links: 
	[
		{
			Name: String,
			RequestUrl: String,
			Method: String
		}
	]
}

Coruson API

GetUsers

Coruson Users

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

HTTP + JSV