API/Services/GetServiceContactRequirements - Revision history

MZabelov at 06:12, 7 March 2019

2019-03-07T06:12:50Z

MZabelov at 06:11, 7 March 2019

2019-03-07T06:11:53Z

JLee at 05:33, 21 July 2016

2016-07-21T05:33:17Z

Scarpenter at 02:53, 29 June 2016

2016-06-29T02:53:37Z

Scarpenter: Created page with "== Get Service Contact Requirements === '''Purpose:''' Some service types require one or more service-level contacts as part of the configuration. This method will retrieve a..."

2016-06-29T02:52:13Z

Created page with "== Get Service Contact Requirements === '''Purpose:''' Some service types require one or more service-level contacts as part of the configuration. This method will retrieve a..."

New page

== 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.

← Older revision		Revision as of 02:53, 29 June 2016
Line 1:		Line 1:
−	== Get Service Contact Requirements ===	+	=== 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).		'''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).

@@ Line 14: / Line 14: @@
 '''Outputs'''
     <SOAP-ENV:Body>
        <ns2:GetServiceContactRequirementsResponse>

@@ Line 29: / Line 29: @@
                    <ns1:TypeOption xsi:nil="true"/>
                    <ns1:IsMandatory>true</ns1:IsMandatory>
                 </ns1:Property>
                 <ns1:Property>

@@ Line 7: / Line 7: @@
     <soapenv:Header/>
     <soapenv:Body>
-       <ser:GetServiceContactRequirements>
+       <urn:GetServiceContactRequirements>
-          <ser:ServicePlanID>1234567</ser:ServicePlanID>
+          <urn:ServicePlanID>1234567</urn:ServicePlanID>
-       </ser:GetServiceContactRequirements>
+       </urn:GetServiceContactRequirements>
     </soapenv:Body>
@@ Line 15: / Line 15: @@
     <SOAP-ENV:Body>
-       <ns1:GetServiceContactRequirementsResponse>
+   <SOAP-ENV:Body>
-          <ns1:ContactType>
+       <ns2:GetServiceContactRequirementsResponse>
-           <ns1:ContactTypeID>116</ns1:ContactTypeID>
+          <ns2:ContactType>
-             <ns1:ContactTypeName>Resident</ns1:ContactTypeName>
+             <ns1:Type ID="121">IPND</ns1:Type>
              <ns1:MinimumRequired>1</ns1:MinimumRequired>
-             <ns1:MaximumRequired>3</ns1:MaximumRequired>
+             <ns1:MaximumRequired>1</ns1:MaximumRequired>
              <ns1:IsAddressOptional>false</ns1:IsAddressOptional>
-             <ns1:PropertyCollections>
+             <ns1:Properties>
                 <ns1:Property>
-                   <ns1:PropertyTypeName>LIVE_ALONE</ns1:PropertyTypeName>
+                   <ns1:Type ID="493">DIRECTORY_LISTING</ns1:Type>
-                   <ns1:PropertyTypeID>307</ns1:PropertyTypeID>
+                   <ns1:ValueType ID="4">List</ns1:ValueType>
-                   <ns1:PropertyValueTypeID>4</ns1:PropertyValueTypeID>
+                   <ns1:ValueValidationRules xsi:nil="true"/>
-                  <ns1:PropertyValueTypeName>List</ns1:PropertyValueTypeName>
+                   <ns1:TypeOption xsi:nil="true"/>
                    <ns1:IsMandatory>true</ns1:IsMandatory>
                 </ns1:Property>
-             </ns1:PropertyCollections>
+               <ns1:Property>
-          </ns1:ContactType>
+                  <ns1:Type ID="494">ALTERNATE_CONTACT</ns1:Type>
-       </ns1:GetServiceContactRequirementsResponse>
+                  <ns1:ValueType ID="5">OnOff</ns1:ValueType>
     </SOAP-ENV:Body>