GRMS Web Services Web Service

GRMS Web Services

Click here for a complete list of operations.

GetRiskAssessment

Pull supplier risk assessment request record which contains supplier data, related ratings, and status.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /api/WebServices.asmx HTTP/1.1
Host: developer.globalrms.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://developer.globalrms.com/GetRiskAssessment"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetRiskAssessment xmlns="https://developer.globalrms.com">
      <RiskAssessmentID>string</RiskAssessmentID>
    </GetRiskAssessment>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetRiskAssessmentResponse xmlns="https://developer.globalrms.com">
      <GetRiskAssessmentResult>
        <RequestDate>dateTime</RequestDate>
        <LastUpdate>dateTime</LastUpdate>
        <ProcessingStatus>unsignedByte</ProcessingStatus>
        <ProcessingStatusDescription>string</ProcessingStatusDescription>
        <OverallRiskRating>string</OverallRiskRating>
        <WeightedRatingScore>decimal</WeightedRatingScore>
        <RiskAssessmentRequest>
          <PartnerAccountNumber>string</PartnerAccountNumber>
          <PartnerName>string</PartnerName>
          <PartnerSubDivision>string</PartnerSubDivision>
          <SubClient1ID>string</SubClient1ID>
          <SubClient1Name>string</SubClient1Name>
          <SubClient2ID>string</SubClient2ID>
          <SubClient2Name>string</SubClient2Name>
          <SubClient3ID>string</SubClient3ID>
          <SubClient3Name>string</SubClient3Name>
          <SubscriptionProgramCode>string</SubscriptionProgramCode>
          <ClientEnrollmentCode>string</ClientEnrollmentCode>
          <CallBackUrl>string</CallBackUrl>
          <SupplierRecordID>string</SupplierRecordID>
          <ParentCompanyName>string</ParentCompanyName>
          <ParentCompanyTaxID>string</ParentCompanyTaxID>
          <CompanyName>string</CompanyName>
          <CompanyDBA>string</CompanyDBA>
          <TaxIDType>string</TaxIDType>
          <TaxID>string</TaxID>
          <ContactFirstName>string</ContactFirstName>
          <ContactLastName>string</ContactLastName>
          <ContactEmail>string</ContactEmail>
          <ContactPhone>string</ContactPhone>
          <AddressStreet1>string</AddressStreet1>
          <AddressStreet2>string</AddressStreet2>
          <AddressCity>string</AddressCity>
          <AddressState>string</AddressState>
          <AddressPostalCode>string</AddressPostalCode>
          <AddressCountryCode>string</AddressCountryCode>
          <ServiceLocation>string</ServiceLocation>
          <ProductServiceType>string</ProductServiceType>
          <ProductsOrServicesDescription>string</ProductsOrServicesDescription>
          <UnlistedProductsOrServices>string</UnlistedProductsOrServices>
          <RiskTier>string</RiskTier>
          <CustomQuestion1>string</CustomQuestion1>
          <CustomQuestion1Answer>string</CustomQuestion1Answer>
          <CustomQuestion2>string</CustomQuestion2>
          <CustomQuestion2Answer>string</CustomQuestion2Answer>
          <CustomQuestion3>string</CustomQuestion3>
          <CustomQuestion3Answer>string</CustomQuestion3Answer>
          <CustomQuestion4>string</CustomQuestion4>
          <CustomQuestion4Answer>string</CustomQuestion4Answer>
          <DiversitySelection>string</DiversitySelection>
          <IsNewEnrollment>boolean</IsNewEnrollment>
          <IsExpired>boolean</IsExpired>
          <RenewalTransactionID>string</RenewalTransactionID>
        </RiskAssessmentRequest>
        <RiskComponents>
          <ScreenSupplierSearch>
            <RiskModuleGroup>string</RiskModuleGroup>
            <RiskComponentID>long</RiskComponentID>
            <ParentRiskComponentID>long</ParentRiskComponentID>
            <RiskComponentCode>string</RiskComponentCode>
            <RiskComponentTitle>string</RiskComponentTitle>
            <RiskAssessmentResult>string</RiskAssessmentResult>
            <RiskAssessmentResultPDF>string</RiskAssessmentResultPDF>
            <RiskAssessmentResultHtmlView>string</RiskAssessmentResultHtmlView>
            <RatingCode>string</RatingCode>
            <RatingDescription>string</RatingDescription>
            <InsurancePolicyRequestType>string</InsurancePolicyRequestType>
            <RatingCompletionDate>dateTime</RatingCompletionDate>
            <Documents xsi:nil="true" />
            <WeightedRatingScore>decimal</WeightedRatingScore>
            <InsurancePolicies xsi:nil="true" />
            <DiversityTypes xsi:nil="true" />
            <Survey xsi:nil="true" />
          </ScreenSupplierSearch>
          <ScreenSupplierSearch>
            <RiskModuleGroup>string</RiskModuleGroup>
            <RiskComponentID>long</RiskComponentID>
            <ParentRiskComponentID>long</ParentRiskComponentID>
            <RiskComponentCode>string</RiskComponentCode>
            <RiskComponentTitle>string</RiskComponentTitle>
            <RiskAssessmentResult>string</RiskAssessmentResult>
            <RiskAssessmentResultPDF>string</RiskAssessmentResultPDF>
            <RiskAssessmentResultHtmlView>string</RiskAssessmentResultHtmlView>
            <RatingCode>string</RatingCode>
            <RatingDescription>string</RatingDescription>
            <InsurancePolicyRequestType>string</InsurancePolicyRequestType>
            <RatingCompletionDate>dateTime</RatingCompletionDate>
            <Documents xsi:nil="true" />
            <WeightedRatingScore>decimal</WeightedRatingScore>
            <InsurancePolicies xsi:nil="true" />
            <DiversityTypes xsi:nil="true" />
            <Survey xsi:nil="true" />
          </ScreenSupplierSearch>
        </RiskComponents>
      </GetRiskAssessmentResult>
    </GetRiskAssessmentResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /api/WebServices.asmx HTTP/1.1
Host: developer.globalrms.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetRiskAssessment xmlns="https://developer.globalrms.com">
      <RiskAssessmentID>string</RiskAssessmentID>
    </GetRiskAssessment>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetRiskAssessmentResponse xmlns="https://developer.globalrms.com">
      <GetRiskAssessmentResult>
        <RequestDate>dateTime</RequestDate>
        <LastUpdate>dateTime</LastUpdate>
        <ProcessingStatus>unsignedByte</ProcessingStatus>
        <ProcessingStatusDescription>string</ProcessingStatusDescription>
        <OverallRiskRating>string</OverallRiskRating>
        <WeightedRatingScore>decimal</WeightedRatingScore>
        <RiskAssessmentRequest>
          <PartnerAccountNumber>string</PartnerAccountNumber>
          <PartnerName>string</PartnerName>
          <PartnerSubDivision>string</PartnerSubDivision>
          <SubClient1ID>string</SubClient1ID>
          <SubClient1Name>string</SubClient1Name>
          <SubClient2ID>string</SubClient2ID>
          <SubClient2Name>string</SubClient2Name>
          <SubClient3ID>string</SubClient3ID>
          <SubClient3Name>string</SubClient3Name>
          <SubscriptionProgramCode>string</SubscriptionProgramCode>
          <ClientEnrollmentCode>string</ClientEnrollmentCode>
          <CallBackUrl>string</CallBackUrl>
          <SupplierRecordID>string</SupplierRecordID>
          <ParentCompanyName>string</ParentCompanyName>
          <ParentCompanyTaxID>string</ParentCompanyTaxID>
          <CompanyName>string</CompanyName>
          <CompanyDBA>string</CompanyDBA>
          <TaxIDType>string</TaxIDType>
          <TaxID>string</TaxID>
          <ContactFirstName>string</ContactFirstName>
          <ContactLastName>string</ContactLastName>
          <ContactEmail>string</ContactEmail>
          <ContactPhone>string</ContactPhone>
          <AddressStreet1>string</AddressStreet1>
          <AddressStreet2>string</AddressStreet2>
          <AddressCity>string</AddressCity>
          <AddressState>string</AddressState>
          <AddressPostalCode>string</AddressPostalCode>
          <AddressCountryCode>string</AddressCountryCode>
          <ServiceLocation>string</ServiceLocation>
          <ProductServiceType>string</ProductServiceType>
          <ProductsOrServicesDescription>string</ProductsOrServicesDescription>
          <UnlistedProductsOrServices>string</UnlistedProductsOrServices>
          <RiskTier>string</RiskTier>
          <CustomQuestion1>string</CustomQuestion1>
          <CustomQuestion1Answer>string</CustomQuestion1Answer>
          <CustomQuestion2>string</CustomQuestion2>
          <CustomQuestion2Answer>string</CustomQuestion2Answer>
          <CustomQuestion3>string</CustomQuestion3>
          <CustomQuestion3Answer>string</CustomQuestion3Answer>
          <CustomQuestion4>string</CustomQuestion4>
          <CustomQuestion4Answer>string</CustomQuestion4Answer>
          <DiversitySelection>string</DiversitySelection>
          <IsNewEnrollment>boolean</IsNewEnrollment>
          <IsExpired>boolean</IsExpired>
          <RenewalTransactionID>string</RenewalTransactionID>
        </RiskAssessmentRequest>
        <RiskComponents>
          <ScreenSupplierSearch>
            <RiskModuleGroup>string</RiskModuleGroup>
            <RiskComponentID>long</RiskComponentID>
            <ParentRiskComponentID>long</ParentRiskComponentID>
            <RiskComponentCode>string</RiskComponentCode>
            <RiskComponentTitle>string</RiskComponentTitle>
            <RiskAssessmentResult>string</RiskAssessmentResult>
            <RiskAssessmentResultPDF>string</RiskAssessmentResultPDF>
            <RiskAssessmentResultHtmlView>string</RiskAssessmentResultHtmlView>
            <RatingCode>string</RatingCode>
            <RatingDescription>string</RatingDescription>
            <InsurancePolicyRequestType>string</InsurancePolicyRequestType>
            <RatingCompletionDate>dateTime</RatingCompletionDate>
            <Documents xsi:nil="true" />
            <WeightedRatingScore>decimal</WeightedRatingScore>
            <InsurancePolicies xsi:nil="true" />
            <DiversityTypes xsi:nil="true" />
            <Survey xsi:nil="true" />
          </ScreenSupplierSearch>
          <ScreenSupplierSearch>
            <RiskModuleGroup>string</RiskModuleGroup>
            <RiskComponentID>long</RiskComponentID>
            <ParentRiskComponentID>long</ParentRiskComponentID>
            <RiskComponentCode>string</RiskComponentCode>
            <RiskComponentTitle>string</RiskComponentTitle>
            <RiskAssessmentResult>string</RiskAssessmentResult>
            <RiskAssessmentResultPDF>string</RiskAssessmentResultPDF>
            <RiskAssessmentResultHtmlView>string</RiskAssessmentResultHtmlView>
            <RatingCode>string</RatingCode>
            <RatingDescription>string</RatingDescription>
            <InsurancePolicyRequestType>string</InsurancePolicyRequestType>
            <RatingCompletionDate>dateTime</RatingCompletionDate>
            <Documents xsi:nil="true" />
            <WeightedRatingScore>decimal</WeightedRatingScore>
            <InsurancePolicies xsi:nil="true" />
            <DiversityTypes xsi:nil="true" />
            <Survey xsi:nil="true" />
          </ScreenSupplierSearch>
        </RiskComponents>
      </GetRiskAssessmentResult>
    </GetRiskAssessmentResponse>
  </soap12:Body>
</soap12:Envelope>