GET api/QMS/Certificates/GetByCode?CertificateCode={CertificateCode} QMS All Services
This service returns all active or inactive certificates that are based on the Certificate Code. (Note: It is an “exact” match on the certificate code.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] |
Parameters
| Name | Description | Additional information | Type |
|---|---|---|---|
| CertificateCode | max 25 characters |
Define this parameter in the request URI. |
String |
Return Type
| Return type | CertificateDTO | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response Information
Response body formats
application/json, text/json
Sample:
{
"CertificateCode": "sample string 1",
"CertificateGUID": "42ebb910-a363-4aab-aad4-cbbc1602ae1d",
"Title": "sample string 2",
"Description": "sample string 3",
"CourseID": 1,
"EffectiveDate": "2025-05-09T12:52:46.290379+00:00",
"ExpiryDate": "2025-05-09T12:52:46.290379+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:
<CertificateDTO xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <CertificateCode>sample string 1</CertificateCode> <CertificateGUID>42ebb910-a363-4aab-aad4-cbbc1602ae1d</CertificateGUID> <Title>sample string 2</Title> <Description>sample string 3</Description> <CourseID>1</CourseID> <EffectiveDate>2025-05-09T12:52:46.290379+00:00</EffectiveDate> <ExpiryDate>2025-05-09T12:52:46.290379+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>