Certificate Integration: GET AOI and Certificate Holders
Note: This update represents only a portion of the AMS360 24R1 release. Please navigate to AMS360 2024 R1 Release Notes to review other enhancements and fixes that were part of this release. |
A number of endpoints have been added in this release to open further development of the Certificate Management tool.
The following endpoints have been added:
-
Getting list of certificates GET "~/customer/certificates" (AFW_CertLiabProp)
-
Parameter is CustID
-
User should have the "360 Toolbox: eForms" Full Access authorization item to reach this endpoint
-
Fields returned: CrtID, CrtNo, DescriptionCtr filtered by CustID
-
If you do not have access to certificates, return a "403 Forbidden"
-
If you do not have access to a customer, or the customer does not exist, return "404 Not Found"
-
Returned as paged list.
-
-
Getting a list of holders for a given certificate GET "~/customer/certificate-holders" (AFW_CertHolderInfo)
-
Parameter is CustomerId
-
User should have the "Customer Certificate Holder" Full Access authorization item to reach this endpoint
-
Fields returned: Name1, Name2, CustomerCertificateHolderId, CustomerCertificateHolderGroupId, CertificateHolderGroupName, ContactName, Address1, Address2, City, State, ZipCode, BusinessAreaCode, BusinessPhone, BusinessPhoneExtension, FaxAreaCode, FaxPhone, FaxPhoneExtension, Email, DesciptionOfOperations, JobType, JobNo, ProjectEndDate, IsBonded, MethodOfDelivery filtered by Certificate ID
-
If IsSameAsMaster=N, then returned description; otherwise the description = null
-
Sorted By Name 1
-
If CRT ID does not exist, return "404 Not Found"
-
Returned as paged list.
-
-
Getting list of other interest GET "~/agency/additional-interest-setup" (AFW_AddOtherInterest)
-
Parameter is IsMasterCertAOI
-
User should have the "Administration Center" and "Administration Center Additional Interest" Full Access authorization items to reach this endpoint
-
Fields returned: Type, Name1, Name2, Contact, Addr1, Addr2, City, State, Zip, and Biz Phone and ext, fax and ext, Email
-
Filter by IsMasterCertAOI; If Y OR N OR missing---> Return All
-
Sorted by Name1, Type
-
Returned as paged list.
-
-
Gets paged list of Certificate Holders by the Certificate's ID GET "~/customer/certificate/holders"
-
Required parameter: CertificateId
-
Optional parameters: Skip, Top, TotalRecords
-
User should have full access to the "Actions: Certificate Holder" authorization item to reach this endpoint
-
Fields returned: CertificateHolderId, CertificateId, Name1, Name2, Address1, Address2, City, State, ZipCode, ContactName, FaxAreaCode, FaxPhone, FaxPhoneExtension, Email, DesciptionOfOperations, JobType, JobNo, ProjectEndDate, IsBonded, IsLicensed, MethodOfDelivery
-
Unique MethodOfDelivery should be shown (IsSameAsMaster is 'N')
-
If you do not have access to certificates, return a "403 Forbidden"
-
If you do not have access to the customer, or the customer does not exist, return "404 Not Found"
-
Returned as paged list.
-