Coruson API

GetStandards

Coruson Standards

The following routes are available for this service:
GET	/api/standards	Query for Coruson Standards

**GetStandards** Parameters:
Name	Parameter	Data Type	Required	Description
StandardId	query	Guid	No	Filter by the StandardId.
Name	query	string	No	Filter by the name of the Standard.
Description	query	string	No	Filter by the description of the Standard.
IsActive	query	BooleanFilter	Yes	Include all archived Standards. By default they will be filtered out. Allowable Values All True False
OrderBy	query	StandardOrder	Yes	Property to order by in Ascending order. Default is 'Name'. Allowable Values Default Name
OrderByDesc	query	StandardOrder	Yes	Property to order by in Descending order. Allowable Values Default Name
ThenBy	query	StandardOrder	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
ThenByDesc	query	StandardOrder	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

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

**GetStandardsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Standards	form	List<Standard>	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

**Standard** Parameters:
Name	Parameter	Data Type	Required
StandardId	form	Guid	No
Name	form	string	No
Description	form	string	No
IsActive	form	bool	No
Clauses	form	List<Clause>	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 .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

                    POST /xml/reply/GetStandards HTTP/1.1 
Host: platform.gaelenlighten.com 
Content-Type: application/xml
Content-Length: length

<GetStandards xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Version>0</Version>
  <Skip>0</Skip>
  <Take>0</Take>
  <OrderBy>Default</OrderBy>
  <OrderByDesc>Default</OrderByDesc>
  <ThenBy>Default</ThenBy>
  <ThenByDesc>Default</ThenByDesc>
  <StandardId>00000000-0000-0000-0000-000000000000</StandardId>
  <Name>String</Name>
  <Description>String</Description>
  <IsActive>All</IsActive>
</GetStandards>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetStandardsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <StatusDescription>String</StatusDescription>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
  <TotalResults>0</TotalResults>
  <Skip>0</Skip>
  <Take>0</Take>
  <Links>
    <Link>
      <Name>String</Name>
      <RequestUrl>String</RequestUrl>
      <Method>String</Method>
    </Link>
  </Links>
  <Standards>
    <Standard>
      <StandardId>00000000-0000-0000-0000-000000000000</StandardId>
      <Name>String</Name>
      <Description>String</Description>
      <IsActive>false</IsActive>
      <Clauses>
        <Clause>
          <ClauseId>00000000-0000-0000-0000-000000000000</ClauseId>
          <Name>String</Name>
          <Description>String</Description>
          <Code>String</Code>
          <ParentId>00000000-0000-0000-0000-000000000000</ParentId>
          <ParentName>String</ParentName>
          <FullHierarchy>String</FullHierarchy>
          <IsApplied>false</IsApplied>
          <AppliedDetails>String</AppliedDetails>
          <StandardId>00000000-0000-0000-0000-000000000000</StandardId>
          <Standard>String</Standard>
          <IsActive>false</IsActive>
        </Clause>
      </Clauses>
    </Standard>
  </Standards>
</GetStandardsResponse>

Coruson API

GetStandards

Coruson Standards

Allowable Values

Allowable Values

Allowable Values

Allowable Values

Allowable Values

HTTP + XML