Difference between revisions of "API/Services/GetServiceContactRequirements"

Revision as of 12:53, 29 June 2016

Get Service Contact Requirements

Purpose: Some service types require one or more service-level contacts as part of the configuration. This method will retrieve any business rules pertaining to service contact requirements so that they can be included with an order. Service level contacts should not be confused with those that are associated with an account (i.e. primary, billing).

Inputs

  <soapenv:Header/>
  <soapenv:Body>
     <ser:GetServiceContactRequirements>
        <ser:ServicePlanID>1234567</ser:ServicePlanID>
     </ser:GetServiceContactRequirements>
  </soapenv:Body>

Outputs

  <SOAP-ENV:Body>
     <ns1:GetServiceContactRequirementsResponse>
        <ns1:ContactType>
          <ns1:ContactTypeID>116</ns1:ContactTypeID>
           <ns1:ContactTypeName>Resident</ns1:ContactTypeName>
           <ns1:MinimumRequired>1</ns1:MinimumRequired>
           <ns1:MaximumRequired>3</ns1:MaximumRequired>
           <ns1:IsAddressOptional>false</ns1:IsAddressOptional>
           <ns1:PropertyCollections>
              <ns1:Property>
                 <ns1:PropertyTypeName>LIVE_ALONE</ns1:PropertyTypeName>
                 <ns1:PropertyTypeID>307</ns1:PropertyTypeID>
                 <ns1:PropertyValueTypeID>4</ns1:PropertyValueTypeID>
                 <ns1:PropertyValueTypeName>List</ns1:PropertyValueTypeName>
                 <ns1:PropertyValueValidationRules/>
                 <ns1:PropertyTypeOption/>
                 <ns1:IsMandatory>true</ns1:IsMandatory>
                 <ns1:PropertyValueListItems>
                    <ns1:PropertyValueListItem>
                       <ns1:ValueListItemValue>Alone</ns1:ValueListItemValue>
                       <ns1:ValueListItemLabel>Alone</ns1:ValueListItemLabel>
                    </ns1:PropertyValueListItem>
                    <ns1:PropertyValueListItem>
                       <ns1:ValueListItemValue>Spouse</ns1:ValueListItemValue>
                       <ns1:ValueListItemLabel>Spouse</ns1:ValueListItemLabel>
                    </ns1:PropertyValueListItem>
                    <ns1:PropertyValueListItem>
                       <ns1:ValueListItemValue>Family</ns1:ValueListItemValue>
                       <ns1:ValueListItemLabel>Family</ns1:ValueListItemLabel>
                    </ns1:PropertyValueListItem>
                 </ns1:PropertyValueListItems>
              </ns1:Property>
           </ns1:PropertyCollections>
        </ns1:ContactType>
     </ns1:GetServiceContactRequirementsResponse>
  </SOAP-ENV:Body>

Error String

• "Missing Service Plan ID" - Service Plan ID is not supplied.
• "Service Plan does not exist" - Service Plan ID supplied does not exist in system.
• "Invalid Service Plan ID" - Service Plan ID supplied does not belong to the same parent group as the API caller.