Emersion - User contributions [en]

API/Services/GetServiceContactRequirements

2019-03-07T06:12:50Z

MZabelov:

=== 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>
<urn:GetServiceContactRequirements>
<urn:ServicePlanID>1234567</urn:ServicePlanID>
</urn:GetServiceContactRequirements>
</soapenv:Body>

'''Outputs'''

<SOAP-ENV:Body>
<ns2:GetServiceContactRequirementsResponse>
<ns2:ContactType>
<ns1:Type ID="121">IPND</ns1:Type>
<ns1:MinimumRequired>1</ns1:MinimumRequired>
<ns1:MaximumRequired>1</ns1:MaximumRequired>
<ns1:IsAddressOptional>false</ns1:IsAddressOptional>
<ns1:Properties>
<ns1:Property>
<ns1:Type ID="493">DIRECTORY_LISTING</ns1:Type>
<ns1:ValueType ID="4">List</ns1:ValueType>
<ns1:ValueValidationRules xsi:nil="true"/>
<ns1:TypeOption xsi:nil="true"/>
<ns1:IsMandatory>true</ns1:IsMandatory>
<ns1:ValueList>
<ns1:ValueListItem>
<ns1:Value>LE</ns1:Value>
<ns1:Label>Listed Entry</ns1:Label>
</ns1:ValueListItem>
<ns1:ValueListItem>
<ns1:Value>UL</ns1:Value>
<ns1:Label>Unlisted Entry</ns1:Label>
</ns1:ValueListItem>
<ns1:ValueListItem>
<ns1:Value>SA</ns1:Value>
<ns1:Label>Suppressed Address</ns1:Label>
</ns1:ValueListItem>
</ns1:ValueList>
</ns1:Property>
<ns1:Property>
<ns1:Type ID="494">ALTERNATE_CONTACT</ns1:Type>
<ns1:ValueType ID="5">OnOff</ns1:ValueType>
<ns1:ValueValidationRules xsi:nil="true"/>
<ns1:TypeOption xsi:nil="true"/>
<ns1:IsMandatory>false</ns1:IsMandatory>
</ns1:Property>
</ns1:Properties>
</ns2:ContactType>
</ns2: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.

API/Services/GetServiceContactRequirements

2019-03-07T06:11:53Z

MZabelov:

=== 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>
<urn:GetServiceContactRequirements>
<urn:ServicePlanID>1234567</urn:ServicePlanID>
</urn:GetServiceContactRequirements>
</soapenv:Body>

'''Outputs'''

<SOAP-ENV:Body>
<SOAP-ENV:Body>
<ns2:GetServiceContactRequirementsResponse>
<ns2:ContactType>
<ns1:Type ID="121">IPND</ns1:Type>
<ns1:MinimumRequired>1</ns1:MinimumRequired>
<ns1:MaximumRequired>1</ns1:MaximumRequired>
<ns1:IsAddressOptional>false</ns1:IsAddressOptional>
<ns1:Properties>
<ns1:Property>
<ns1:Type ID="493">DIRECTORY_LISTING</ns1:Type>
<ns1:ValueType ID="4">List</ns1:ValueType>
<ns1:ValueValidationRules xsi:nil="true"/>
<ns1:TypeOption xsi:nil="true"/>
<ns1:IsMandatory>true</ns1:IsMandatory>
<ns1:ValueList>
<ns1:ValueListItem>
<ns1:Value>LE</ns1:Value>
<ns1:Label>Listed Entry</ns1:Label>
</ns1:ValueListItem>
<ns1:ValueListItem>
<ns1:Value>UL</ns1:Value>
<ns1:Label>Unlisted Entry</ns1:Label>
</ns1:ValueListItem>
<ns1:ValueListItem>
<ns1:Value>SA</ns1:Value>
<ns1:Label>Suppressed Address</ns1:Label>
</ns1:ValueListItem>
</ns1:ValueList>
</ns1:Property>
<ns1:Property>
<ns1:Type ID="494">ALTERNATE_CONTACT</ns1:Type>
<ns1:ValueType ID="5">OnOff</ns1:ValueType>
<ns1:ValueValidationRules xsi:nil="true"/>
<ns1:TypeOption xsi:nil="true"/>
<ns1:IsMandatory>false</ns1:IsMandatory>
</ns1:Property>
</ns1:Properties>
</ns2:ContactType>
</ns2: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.

API/Services/GetServiceConfigurationRequirements

2019-03-07T06:02:46Z

MZabelov:

'''Purpose '''

Retrieve all the object properties that need to be entered (along with whether they are mandatory or not).

'''Inputs'''
<soapenv:Header/>
<soapenv:Body>
<urn:GetServiceConfigurationRequirements>
<urn:ServicePlanID>1234567</urn:ServicePlanID>
<urn:TransferType>CHURN</urn:TransferType>
</urn:GetServiceConfigurationRequirements>
</soapenv:Body>

'''Output'''

<SOAP-ENV:Body>
<ns2:GetServiceConfigurationRequirementsResponse>
<ns2:Property>
<ns1:Type ID="221">MOBILE_AUTH_DOB</ns1:Type>
<ns1:ValueType ID="1">DateOfBirth</ns1:ValueType>
<ns1:ValidationRules/>
<ns1:TypeOption/>
<ns1:IsMandatory>false</ns1:IsMandatory>
</ns2:Property>
<ns2:Property>
<ns1:Type ID="359">KEY_HIDE_YN</ns1:Type>
<ns1:ValueType ID="4">List</ns1:ValueType>
<ns1:ValidationRules/>
<ns1:TypeOption/>
<ns1:IsMandatory>true</ns1:IsMandatory>
<ns1:ValueList>
<ns1:ValueListItem>
<ns1:Value>Yes</ns1:Value>
<ns1:Label>Yes</ns1:Label>
</ns1:ValueListItem>
<ns1:ValueListItem>
<ns1:Value>No</ns1:Value>
<ns1:Label>No</ns1:Label>
</ns1:ValueListItem>
</ns1:ValueList>
</ns2:Property>
</ns2:GetServiceConfigurationRequirementsResponse>
</SOAP-ENV:Body>

'''Error String'''

* "Missing Service Plan ID" - Service Plan ID is not supplied.
* "Invalid Service Plan ID" - Service Plan ID supplied does not belong to the same parent group as the API caller.
* "Service Plan does not exist" - Service Plan ID supplied does not exist in system.
* "Missing Transfer Type" - Transfer Type is not supplied.
* "Invalid Transfer Type. Valid input: 'NEW', 'CHURN' or 'INTERNAL CHURN'" - Invalid input received.
* "Invalid Service Plan (Missing Service Type)" - Service Plan ID supplied does not have a valid Service Type.
* "Invalid Service Plan (Missing Service Check Type)" - Service Plan ID supplied does not have a valid Service Check Type.