GET api/QMS.Certificates/DefaultAction

GET api/QMS/Certificates/DefaultAction QMS All Services

This service returns all active and inactive certificates. (Note: It does not include deleted certificates.)

Request Information

Headers

Fields	Type	M/O/C	Definition
AccountLoginName	String(50)	Mandatory	Login name of an account used for logging into Galaxy application to perform the service call
AccountPassword	String(50)	Mandatory	Password of an account used for logging into Galaxy application to perform the service call
SourceSystemID	String(50)	Mandatory	Name or ID of application or system that initiated the call.
DomainID	String(50)	Mandatory	Name or ID of the domain that the call is being made to. (Value will be 1, if the site only has one domain)
Accept	String	Optional	Format in which client expects the response: [application/json] (default), [application/xml]
ContentType	String	Optional	Format in which client is sending the request: [application/json] (default), [application/xml]

Return Type

Return type

CertificateDTO[]

CertificateDTO:

PropertyName	Type	Required
CertificateCode	String	Mandatory
CertificateGUID	Nullable<Guid>	Optional
Title	String	Optional
Description	String	Optional
CourseID	Nullable<Int32>	Optional
EffectiveDate	Nullable<DateTime>	Optional
ExpiryDate	Nullable<DateTime>	Optional
CertificatePeriodID	Nullable<Int32>	Optional
RecurrentCourseID	Nullable<Int32>	Optional
IsEnroll	Nullable<Boolean>	Optional
EnrollmentStartOffsetDays	Nullable<Int32>	Optional
EnrollmentExpiryOffsetDays	Nullable<Int32>	Optional
IsUpdateFromEnrollment	Nullable<Boolean>	Optional
IsGenerateDocument	Nullable<Boolean>	Optional
DocumentTemplate	String	Optional
FormID	Nullable<Int32>	Optional
DomainID	Int32	Optional
EnrollmentStartOffsetPeriodTypeID	Int32	Optional
EnrollmentStartOffsetParameter	String	Optional
EnrollmentStartOffsetPeriodRoundingTypeID	Int32	Optional
EnrollmentExpiryOffsetPeriodTypeID	Int32	Optional
EnrollmentExpiryOffsetParameter	String	Optional
EnrollmentExpiryOffsetPeriodRoundingTypeID	Int32	Optional
IsRecurrent	Boolean	Display

Response Information

Response body formats

application/json, text/json

Sample:

[
  {
    "CertificateCode": "sample string 1",
    "CertificateGUID": "a8aa68ad-f349-4287-b6d1-d4525f1314ea",
    "Title": "sample string 2",
    "Description": "sample string 3",
    "CourseID": 1,
    "EffectiveDate": "2025-05-09T11:40:38.3240026+00:00",
    "ExpiryDate": "2025-05-09T11:40:38.3240026+00:00",
    "CertificatePeriodID": 1,
    "RecurrentCourseID": 1,
    "IsEnroll": true,
    "EnrollmentStartOffsetDays": 1,
    "EnrollmentExpiryOffsetDays": 1,
    "IsUpdateFromEnrollment": true,
    "IsGenerateDocument": true,
    "DocumentTemplate": "sample string 4",
    "FormID": 1,
    "DomainID": 5,
    "EnrollmentStartOffsetPeriodTypeID": 6,
    "EnrollmentStartOffsetParameter": "sample string 7",
    "EnrollmentStartOffsetPeriodRoundingTypeID": 8,
    "EnrollmentExpiryOffsetPeriodTypeID": 9,
    "EnrollmentExpiryOffsetParameter": "sample string 10",
    "EnrollmentExpiryOffsetPeriodRoundingTypeID": 11,
    "IsRecurrent": true
  },
  {
    "CertificateCode": "sample string 1",
    "CertificateGUID": "a8aa68ad-f349-4287-b6d1-d4525f1314ea",
    "Title": "sample string 2",
    "Description": "sample string 3",
    "CourseID": 1,
    "EffectiveDate": "2025-05-09T11:40:38.3240026+00:00",
    "ExpiryDate": "2025-05-09T11:40:38.3240026+00:00",
    "CertificatePeriodID": 1,
    "RecurrentCourseID": 1,
    "IsEnroll": true,
    "EnrollmentStartOffsetDays": 1,
    "EnrollmentExpiryOffsetDays": 1,
    "IsUpdateFromEnrollment": true,
    "IsGenerateDocument": true,
    "DocumentTemplate": "sample string 4",
    "FormID": 1,
    "DomainID": 5,
    "EnrollmentStartOffsetPeriodTypeID": 6,
    "EnrollmentStartOffsetParameter": "sample string 7",
    "EnrollmentStartOffsetPeriodRoundingTypeID": 8,
    "EnrollmentExpiryOffsetPeriodTypeID": 9,
    "EnrollmentExpiryOffsetParameter": "sample string 10",
    "EnrollmentExpiryOffsetPeriodRoundingTypeID": 11,
    "IsRecurrent": true
  },
  {
    "CertificateCode": "sample string 1",
    "CertificateGUID": "a8aa68ad-f349-4287-b6d1-d4525f1314ea",
    "Title": "sample string 2",
    "Description": "sample string 3",
    "CourseID": 1,
    "EffectiveDate": "2025-05-09T11:40:38.3240026+00:00",
    "ExpiryDate": "2025-05-09T11:40:38.3240026+00:00",
    "CertificatePeriodID": 1,
    "RecurrentCourseID": 1,
    "IsEnroll": true,
    "EnrollmentStartOffsetDays": 1,
    "EnrollmentExpiryOffsetDays": 1,
    "IsUpdateFromEnrollment": true,
    "IsGenerateDocument": true,
    "DocumentTemplate": "sample string 4",
    "FormID": 1,
    "DomainID": 5,
    "EnrollmentStartOffsetPeriodTypeID": 6,
    "EnrollmentStartOffsetParameter": "sample string 7",
    "EnrollmentStartOffsetPeriodRoundingTypeID": 8,
    "EnrollmentExpiryOffsetPeriodTypeID": 9,
    "EnrollmentExpiryOffsetParameter": "sample string 10",
    "EnrollmentExpiryOffsetPeriodRoundingTypeID": 11,
    "IsRecurrent": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfCertificateDTO xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CertificateDTO>
    <CertificateCode>sample string 1</CertificateCode>
    <CertificateGUID>a8aa68ad-f349-4287-b6d1-d4525f1314ea</CertificateGUID>
    <Title>sample string 2</Title>
    <Description>sample string 3</Description>
    <CourseID>1</CourseID>
    <EffectiveDate>2025-05-09T11:40:38.3240026+00:00</EffectiveDate>
    <ExpiryDate>2025-05-09T11:40:38.3240026+00:00</ExpiryDate>
    <CertificatePeriodID>1</CertificatePeriodID>
    <RecurrentCourseID>1</RecurrentCourseID>
    <IsEnroll>true</IsEnroll>
    <EnrollmentStartOffsetDays>1</EnrollmentStartOffsetDays>
    <EnrollmentExpiryOffsetDays>1</EnrollmentExpiryOffsetDays>
    <IsUpdateFromEnrollment>true</IsUpdateFromEnrollment>
    <IsGenerateDocument>true</IsGenerateDocument>
    <DocumentTemplate>sample string 4</DocumentTemplate>
    <FormID>1</FormID>
    <DomainID>5</DomainID>
    <EnrollmentStartOffsetPeriodTypeID>6</EnrollmentStartOffsetPeriodTypeID>
    <EnrollmentStartOffsetParameter>sample string 7</EnrollmentStartOffsetParameter>
    <EnrollmentStartOffsetPeriodRoundingTypeID>8</EnrollmentStartOffsetPeriodRoundingTypeID>
    <EnrollmentExpiryOffsetPeriodTypeID>9</EnrollmentExpiryOffsetPeriodTypeID>
    <EnrollmentExpiryOffsetParameter>sample string 10</EnrollmentExpiryOffsetParameter>
    <EnrollmentExpiryOffsetPeriodRoundingTypeID>11</EnrollmentExpiryOffsetPeriodRoundingTypeID>
    <IsRecurrent>true</IsRecurrent>
  </CertificateDTO>
  <CertificateDTO>
    <CertificateCode>sample string 1</CertificateCode>
    <CertificateGUID>a8aa68ad-f349-4287-b6d1-d4525f1314ea</CertificateGUID>
    <Title>sample string 2</Title>
    <Description>sample string 3</Description>
    <CourseID>1</CourseID>
    <EffectiveDate>2025-05-09T11:40:38.3240026+00:00</EffectiveDate>
    <ExpiryDate>2025-05-09T11:40:38.3240026+00:00</ExpiryDate>
    <CertificatePeriodID>1</CertificatePeriodID>
    <RecurrentCourseID>1</RecurrentCourseID>
    <IsEnroll>true</IsEnroll>
    <EnrollmentStartOffsetDays>1</EnrollmentStartOffsetDays>
    <EnrollmentExpiryOffsetDays>1</EnrollmentExpiryOffsetDays>
    <IsUpdateFromEnrollment>true</IsUpdateFromEnrollment>
    <IsGenerateDocument>true</IsGenerateDocument>
    <DocumentTemplate>sample string 4</DocumentTemplate>
    <FormID>1</FormID>
    <DomainID>5</DomainID>
    <EnrollmentStartOffsetPeriodTypeID>6</EnrollmentStartOffsetPeriodTypeID>
    <EnrollmentStartOffsetParameter>sample string 7</EnrollmentStartOffsetParameter>
    <EnrollmentStartOffsetPeriodRoundingTypeID>8</EnrollmentStartOffsetPeriodRoundingTypeID>
    <EnrollmentExpiryOffsetPeriodTypeID>9</EnrollmentExpiryOffsetPeriodTypeID>
    <EnrollmentExpiryOffsetParameter>sample string 10</EnrollmentExpiryOffsetParameter>
    <EnrollmentExpiryOffsetPeriodRoundingTypeID>11</EnrollmentExpiryOffsetPeriodRoundingTypeID>
    <IsRecurrent>true</IsRecurrent>
  </CertificateDTO>
  <CertificateDTO>
    <CertificateCode>sample string 1</CertificateCode>
    <CertificateGUID>a8aa68ad-f349-4287-b6d1-d4525f1314ea</CertificateGUID>
    <Title>sample string 2</Title>
    <Description>sample string 3</Description>
    <CourseID>1</CourseID>
    <EffectiveDate>2025-05-09T11:40:38.3240026+00:00</EffectiveDate>
    <ExpiryDate>2025-05-09T11:40:38.3240026+00:00</ExpiryDate>
    <CertificatePeriodID>1</CertificatePeriodID>
    <RecurrentCourseID>1</RecurrentCourseID>
    <IsEnroll>true</IsEnroll>
    <EnrollmentStartOffsetDays>1</EnrollmentStartOffsetDays>
    <EnrollmentExpiryOffsetDays>1</EnrollmentExpiryOffsetDays>
    <IsUpdateFromEnrollment>true</IsUpdateFromEnrollment>
    <IsGenerateDocument>true</IsGenerateDocument>
    <DocumentTemplate>sample string 4</DocumentTemplate>
    <FormID>1</FormID>
    <DomainID>5</DomainID>
    <EnrollmentStartOffsetPeriodTypeID>6</EnrollmentStartOffsetPeriodTypeID>
    <EnrollmentStartOffsetParameter>sample string 7</EnrollmentStartOffsetParameter>
    <EnrollmentStartOffsetPeriodRoundingTypeID>8</EnrollmentStartOffsetPeriodRoundingTypeID>
    <EnrollmentExpiryOffsetPeriodTypeID>9</EnrollmentExpiryOffsetPeriodTypeID>
    <EnrollmentExpiryOffsetParameter>sample string 10</EnrollmentExpiryOffsetParameter>
    <EnrollmentExpiryOffsetPeriodRoundingTypeID>11</EnrollmentExpiryOffsetPeriodRoundingTypeID>
    <IsRecurrent>true</IsRecurrent>
  </CertificateDTO>
</ArrayOfCertificateDTO>