PUT api/QMS/UserCertificates/UpdateWithReturn   QMS   All Services

Update any User Certificate record by passing in a UserCertificate ID. CertificateCode, and at least one of ExpiryDate or CompletedDate must be included. NOTE: updates will not keep audit history and should not be confused with renewing, which is creating a new record.

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

NameDescriptionAdditional informationType
model 
Conditional (other than the ID) fields can be updated here.

Define this parameter in the request body.

 UserCertificateDTO
UserCertificateDTO:
PropertyNameTypeRequiredDescription
CertificateCode String Conditional
LoginName String Conditional
ExpiryDate Nullable<DateTime> Conditional
CompletedDate Nullable<DateTime> Conditional
IsForceCompleted Boolean Display
IsRecurrent Boolean Display
RecurrentPeriod String Display
UserCertificateID Int32 Conditional
LicenseNumber String Optional
IssuingCountryID String Optional
Hours String Optional
Remarks String Optional
Grade String Optional
Trainer String Optional
UpdatedDate DateTime Display
UpdatedBy String Display
IsDraft Boolean Display
IsSuspended Boolean Display

Request body formats

application/json, text/json

Sample: 
{
  "CertificateCode": "sample string 1",
  "LoginName": "sample string 2",
  "ExpiryDate": "2025-05-09T11:49:56.6692279+00:00",
  "CompletedDate": "2025-05-09T11:49:56.6692279+00:00",
  "IsForceCompleted": true,
  "IsRecurrent": true,
  "RecurrentPeriod": "sample string 5",
  "UserCertificateID": 6,
  "LicenseNumber": "sample string 7",
  "IssuingCountryID": "sample string 8",
  "Hours": "sample string 9",
  "Remarks": "sample string 10",
  "Grade": "sample string 11",
  "Trainer": "sample string 12",
  "UpdatedDate": "2025-05-09T11:49:56.6692279+00:00",
  "UpdatedBy": "sample string 14",
  "IsDraft": true,
  "IsSuspended": true
}

application/xml, text/xml

Sample: 
<UserCertificateDTO xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CertificateCode>sample string 1</CertificateCode>
  <LoginName>sample string 2</LoginName>
  <ExpiryDate>2025-05-09T11:49:56.6692279+00:00</ExpiryDate>
  <CompletedDate>2025-05-09T11:49:56.6692279+00:00</CompletedDate>
  <IsForceCompleted>true</IsForceCompleted>
  <IsRecurrent>true</IsRecurrent>
  <RecurrentPeriod>sample string 5</RecurrentPeriod>
  <UserCertificateID>6</UserCertificateID>
  <LicenseNumber>sample string 7</LicenseNumber>
  <IssuingCountryID>sample string 8</IssuingCountryID>
  <Hours>sample string 9</Hours>
  <Remarks>sample string 10</Remarks>
  <Grade>sample string 11</Grade>
  <Trainer>sample string 12</Trainer>
  <UpdatedDate>2025-05-09T11:49:56.6692279+00:00</UpdatedDate>
  <UpdatedBy>sample string 14</UpdatedBy>
  <IsDraft>true</IsDraft>
  <IsSuspended>true</IsSuspended>
</UserCertificateDTO>

Return Type

Return typeUserCertificateDTO
UserCertificateDTO:
PropertyNameTypeRequiredDescription
CertificateCode String Conditional
LoginName String Conditional
ExpiryDate Nullable<DateTime> Conditional
CompletedDate Nullable<DateTime> Conditional
IsForceCompleted Boolean Display
IsRecurrent Boolean Display
RecurrentPeriod String Display
UserCertificateID Int32 Conditional
LicenseNumber String Optional
IssuingCountryID String Optional
Hours String Optional
Remarks String Optional
Grade String Optional
Trainer String Optional
UpdatedDate DateTime Display
UpdatedBy String Display
IsDraft Boolean Display
IsSuspended Boolean Display

Response Information

Response body formats

application/json, text/json

Sample: 
{
  "CertificateCode": "sample string 1",
  "LoginName": "sample string 2",
  "ExpiryDate": "2025-05-09T11:49:56.6692279+00:00",
  "CompletedDate": "2025-05-09T11:49:56.6692279+00:00",
  "IsForceCompleted": true,
  "IsRecurrent": true,
  "RecurrentPeriod": "sample string 5",
  "UserCertificateID": 6,
  "LicenseNumber": "sample string 7",
  "IssuingCountryID": "sample string 8",
  "Hours": "sample string 9",
  "Remarks": "sample string 10",
  "Grade": "sample string 11",
  "Trainer": "sample string 12",
  "UpdatedDate": "2025-05-09T11:49:56.6692279+00:00",
  "UpdatedBy": "sample string 14",
  "IsDraft": true,
  "IsSuspended": true
}

application/xml, text/xml

Sample: 
<UserCertificateDTO xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CertificateCode>sample string 1</CertificateCode>
  <LoginName>sample string 2</LoginName>
  <ExpiryDate>2025-05-09T11:49:56.6692279+00:00</ExpiryDate>
  <CompletedDate>2025-05-09T11:49:56.6692279+00:00</CompletedDate>
  <IsForceCompleted>true</IsForceCompleted>
  <IsRecurrent>true</IsRecurrent>
  <RecurrentPeriod>sample string 5</RecurrentPeriod>
  <UserCertificateID>6</UserCertificateID>
  <LicenseNumber>sample string 7</LicenseNumber>
  <IssuingCountryID>sample string 8</IssuingCountryID>
  <Hours>sample string 9</Hours>
  <Remarks>sample string 10</Remarks>
  <Grade>sample string 11</Grade>
  <Trainer>sample string 12</Trainer>
  <UpdatedDate>2025-05-09T11:49:56.6692279+00:00</UpdatedDate>
  <UpdatedBy>sample string 14</UpdatedBy>
  <IsDraft>true</IsDraft>
  <IsSuspended>true</IsSuspended>
</UserCertificateDTO>