| GET | /api/standards/clauses | Query for Coruson Standard Clauses |
|---|
| 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
|
| 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
|
| OrderBy | query | ClauseOrder | Yes | Property to order by in Ascending order. Default is 'Name'.Allowable Values
|
| OrderByDesc | query | ClauseOrder | Yes | Property to order by in Descending order.Allowable Values
|
| 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
|
| 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
|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Clauses | form | List<Clause> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TotalResults | form | int | No | |
| Skip | form | int | No | |
| Take | form | int | No | |
| Links | form | List<Link> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusDescription | form | string | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| RequestUrl | form | string | No | |
| Method | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/GetClauses HTTP/1.1
Host: platform.gaelenlighten.com
Content-Type: application/json
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: application/json
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}]}