Coruson API

GetClauses

Coruson Standards

The following routes are available for this service:
GET	/api/standards/clauses	Query for Coruson Standard Clauses

**GetClauses** Parameters:
Name	Parameter	Data Type	Required	Description
ClauseId	query	Guid	No	Filter by the ClauseId.
Name	query	string	No	Filter by the name of the Clause.
Description	query	string	No	Filter by the description of the Clause.
Code	query	string	No	Filter by the code of the Clause.
ParentId	query	Guid	No	Filter by the parent Clause Id of the Clause.
ParentName	query	string	No	Filter by the name of of the parent the Clause(s) belong to.
FullHierarchy	query	string	No	Filter clauses by providing their full hierarchy. Format should be: {Root}\\\\..\\\\..\\\\{Parent}.
IsApplied	query	BooleanFilter	Yes	Get all Clauses based on their 'Applied' status. By default Clauses of both Applied states will be returned. Allowable Values All True False
AppliedDetails	query	string	No	Filter by the applied details of the Clause.
StandardId	query	Guid	No	Filter by the Id of the Standard the Clause(s) belongs to.
Standard	query	string	No	Filter by the name of the Standard the Clause(s) belongs to.
IsActive	query	BooleanFilter	Yes	Include all archived Standard Clauses. By default they will be filtered out. Allowable Values All True False
OrderBy	query	ClauseOrder	Yes	Property to order by in Ascending order. Default is 'Name'. Allowable Values Default Name Standard ParentName AppliedStatus
OrderByDesc	query	ClauseOrder	Yes	Property to order by in Descending order. Allowable Values Default Name Standard ParentName AppliedStatus
ThenBy	query	ClauseOrder	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 Name Standard ParentName AppliedStatus
ThenByDesc	query	ClauseOrder	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 Name Standard ParentName AppliedStatus

**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

**GetClausesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Clauses	form	List<Clause>	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

**Clause** Parameters:
Name	Parameter	Data Type	Required
ClauseId	form	Guid	No
Name	form	string	No
Description	form	string	No
Code	form	string	No
ParentId	form	Guid?	No
ParentName	form	string	No
FullHierarchy	form	string	No
IsApplied	form	bool	No
AppliedDetails	form	string	No
StandardId	form	Guid	No
Standard	form	string	No
IsActive	form	bool	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/GetClauses HTTP/1.1 
Host: platform.gaelenlighten.com 
Content-Type: text/jsv
Content-Length: length

{
	ClauseId: 00000000-0000-0000-0000-000000000000,
	Skip: 0,
	Version: 0,
	Name: String,
	Take: 0,
	Description: String,
	Code: String,
	ParentId: 00000000-0000-0000-0000-000000000000,
	ParentName: String,
	FullHierarchy: String,
	IsApplied: All,
	AppliedDetails: String,
	StandardId: 00000000-0000-0000-0000-000000000000,
	Standard: String,
	IsActive: All,
	OrderBy: Default,
	OrderByDesc: Default,
	ThenBy: Default,
	ThenByDesc: Default
}

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

{
	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
		}
	],
	Clauses: 
	[
		{
			Name: String,
			Description: String,
			Code: String,
			ParentId: 00000000-0000-0000-0000-000000000000,
			ParentName: String,
			FullHierarchy: String,
			IsApplied: False,
			AppliedDetails: String,
			Standard: String,
			IsActive: False
		}
	]
}

Coruson API

GetClauses

Coruson Standards

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

HTTP + JSV