Telgoo5 APIs

RemoveLine

This XML API is used to remove RemoveLine from the MDN.This XML API does not change the account status of VCare account, it only changes the status at carrier level.

End Point	https://www.vcareapi.com/vcareOssApi/RemoveLine/
Field (Short Description)	Value/Tag Name	Format	Field Example	Type	Notes	Validation rules
VENDOR ID		string	Vcarecorporation	Required	A unique Vendor ID is associated with the MVNO/OSS partner. This is used for authorization purpose and can be obtained by contacting your account manager.
USER NAME		string	Vcarecorporation	Required	A unique User name is associated with the MVNO/OSS partner. This is used for authorization purpose and can be obtained by contacting your account manager.
PASSWORD		string	Vcarecorporation	Required	This is a random string which is generated by Vcare and is tied to the MVNO/OSS user name. This is specifically used for authentication purpose and can be obtained by contacting your account manager.
PIN		string	123456789	Required	This is generated by Vcare to provide an additional layer of security in the Interim API. This is used for authentication purpose and can be obtained by contacting your account manager.
REFERENCE NUMBER		string	123456789	Required	Auto generated unique reference number is required to be passed with each transaction.
PARENT MDN		string	1234567890	Required	This is the telephone number which is attached to the subscriber's account
CHILDMDN		string	1234567890	Required	This is the telephone number which is attached to the subscriber's account
SOURCE		string	API	Optional	Source of the order/application	Expected Value:API, TABLET, IVR, WEBSITE
AGENTID		string	John Doe	Required	This is the Telgoo5 user id.For the Agent/Employee who is sending the API request.
AGENTPASSWORD		string	John Doe	Conditional	This is the password for the Agent Id mentioned above. This is configuration level field. If you have set the permissions for the Agent Id for the requirement of the password in API transactions then you will need to pass the Agent Password in all the XML API transaction,else if you have set the permissions to password not required then you don't need to pass the Agent Password in the XML API.

Sample Request XML

<?xml version="1.0" encoding="utf-8"?>
<VCAREOSSAPI xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<CREDENTIALS>
	<VENDORID></VENDORID>
	<USERNAME></USERNAME>
	<PASSWORD></PASSWORD>
	<PIN></PIN>
	<REFERENCENUMBER></REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
	<REMOVELINE>
		<PARENTMDN></PARENTMDN>
		<CHILDMDN></CHILDMDN>
		<AGENTID></AGENTID>
		<AGENTPASSWORD></AGENTPASSWORD>
		<SOURCE>API</SOURCE>
	</REMOVELINE>
</VCAREOSS>
</VCAREOSSAPI>

List of status code, description and resolution.
Status Code	Description	How to Resolve?
00	SUCCESS	SUCCESS
01	Error Received from Carrier.	Please try again with valid data.
13	Password is invalid.	Provide a valid Password.
16	Vendor not found. Wrong credentials.	Please enter valid vendor credentials.
356	Agent ID cannot be blank.	Please provide Agent ID as it cannot be blank.
457	Invalid Source.	Please provide a valid Source. Given value is invalid for Source.
601	Parent MDN is required.	Provide a valid Parent MDN. Parent MDN should not be blank.
602	Child MDN is required.	Provide a valid Child MDN. Child MDN should not be blank.
603	Parent MDN Invalid.	Please provide a valid Parent MDN. Given value is invalid for Parent MDN.
604	Child MDN Invalid.	Please provide a valid Child MDN. Given value is invalid for Child MDN.
609	Parent MDN not found.	Please provide a valid Parent MDN. Given value is not available in system for Parent MDN.
615	Parent account status Inactive.	Parent account status is Inactive. Please enter a Parent account which has active status.
616	Parent account status Suspend .	Parent account status is Suspend. Please enter a Parent account which has active status.
617	Parent account status Undeliverable.	Parent account status is Undeliverable. Please enter a Parent account which has active status.
618	Child account status Inactive.	Child account status is Inactive. Please enter a Child account which has active status.
619	Child account status Suspend .	Child account status is Suspend. Please enter a Child account which has active status.
620	Child account status Undeliverable.	Child account status is Undeliverable. Please enter a Child account which has active status.
621	This parent has no child.	Enter a valid parent as this parent has no child.
622	This child is not associated with this parent.	Enter a valid child as this child is not associated with the entered parent.

Sample Response

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <credentials>
        <vendorId>Vcarecorporation</vendorId>
        <referenceNumber>1111111111</referenceNumber>
    </credentials>
    <RemoveLine>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <mdn></mdn>
    </RemoveLine>
</VcareOssApi>

SUCCESS

Sample Fail Response: 1

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<RemoveLine>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</RemoveLine>
</VcareOssApi>

Error Description: Error Received from Carrier.

How to Resolve?: Please try again with valid data.

Sample Fail Response: 2

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<RemoveLine>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</RemoveLine>
</VcareOssApi>

Error Description: Password is invalid.

How to Resolve?: Provide a valid Password.

Sample Fail Response: 3

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<RemoveLine>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</RemoveLine>
</VcareOssApi>

Error Description: Vendor not found. Wrong credentials.

How to Resolve?: Please enter valid vendor credentials.

Sample Fail Response: 4

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<RemoveLine>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</RemoveLine>
</VcareOssApi>

Error Description: Agent ID cannot be blank.

How to Resolve?: Please provide Agent ID as it cannot be blank.

Sample Fail Response: 5

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<RemoveLine>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</RemoveLine>
</VcareOssApi>

Error Description: Invalid Source.

How to Resolve?: Please provide a valid Source. Given value is invalid for Source.

Sample Fail Response: 6

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<RemoveLine>
	<statusCode>601</statusCode>
	<description>FAIL</description>
	<errorDescription>Parent MDN is required.</errorDescription>
</RemoveLine>
</VcareOssApi>

Error Description: Parent MDN is required.

How to Resolve?: Provide a valid Parent MDN. Parent MDN should not be blank.

Sample Fail Response: 7

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<RemoveLine>
	<statusCode>602</statusCode>
	<description>FAIL</description>
	<errorDescription>Child MDN is required.</errorDescription>
</RemoveLine>
</VcareOssApi>

Error Description: Child MDN is required.

How to Resolve?: Provide a valid Child MDN. Child MDN should not be blank.

Sample Fail Response: 8

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<RemoveLine>
	<statusCode>603</statusCode>
	<description>FAIL</description>
	<errorDescription>Parent MDN Invalid.</errorDescription>
</RemoveLine>
</VcareOssApi>

Error Description: Parent MDN Invalid.

How to Resolve?: Please provide a valid Parent MDN. Given value is invalid for Parent MDN.

Sample Fail Response: 9

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<RemoveLine>
	<statusCode>604</statusCode>
	<description>FAIL</description>
	<errorDescription>Child MDN Invalid.</errorDescription>
</RemoveLine>
</VcareOssApi>

Error Description: Child MDN Invalid.

How to Resolve?: Please provide a valid Child MDN. Given value is invalid for Child MDN.

Sample Fail Response: 10

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<RemoveLine>
	<statusCode>609</statusCode>
	<description>FAIL</description>
	<errorDescription>Parent MDN not found.</errorDescription>
</RemoveLine>
</VcareOssApi>

Error Description: Parent MDN not found.

How to Resolve?: Please provide a valid Parent MDN. Given value is not available in system for Parent MDN.

Sample Fail Response: 11

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<RemoveLine>
	<statusCode>615</statusCode>
	<description>FAIL</description>
	<errorDescription>Parent account status Inactive.</errorDescription>
</RemoveLine>
</VcareOssApi>

Error Description: Parent account status Inactive.

How to Resolve?: Parent account status is Inactive. Please enter a Parent account which has active status.

Sample Fail Response: 12

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<RemoveLine>
	<statusCode>616</statusCode>
	<description>FAIL</description>
	<errorDescription>Parent account status Suspend .</errorDescription>
</RemoveLine>
</VcareOssApi>

Error Description: Parent account status Suspend .

How to Resolve?: Parent account status is Suspend. Please enter a Parent account which has active status.

Sample Fail Response: 13

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<RemoveLine>
	<statusCode>617</statusCode>
	<description>FAIL</description>
	<errorDescription>Parent account status Undeliverable.</errorDescription>
</RemoveLine>
</VcareOssApi>

Error Description: Parent account status Undeliverable.

How to Resolve?: Parent account status is Undeliverable. Please enter a Parent account which has active status.

Sample Fail Response: 14

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<RemoveLine>
	<statusCode>618</statusCode>
	<description>FAIL</description>
	<errorDescription>Child account status Inactive.</errorDescription>
</RemoveLine>
</VcareOssApi>

Error Description: Child account status Inactive.

How to Resolve?: Child account status is Inactive. Please enter a Child account which has active status.

Sample Fail Response: 15

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<RemoveLine>
	<statusCode>619</statusCode>
	<description>FAIL</description>
	<errorDescription>Child account status Suspend .</errorDescription>
</RemoveLine>
</VcareOssApi>

Error Description: Child account status Suspend .

How to Resolve?: Child account status is Suspend. Please enter a Child account which has active status.

Sample Fail Response: 16

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<RemoveLine>
	<statusCode>620</statusCode>
	<description>FAIL</description>
	<errorDescription>Child account status Undeliverable.</errorDescription>
</RemoveLine>
</VcareOssApi>

Error Description: Child account status Undeliverable.

How to Resolve?: Child account status is Undeliverable. Please enter a Child account which has active status.

Sample Fail Response: 17

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<RemoveLine>
	<statusCode>621</statusCode>
	<description>FAIL</description>
	<errorDescription>This parent has no child.</errorDescription>
</RemoveLine>
</VcareOssApi>

Error Description: This parent has no child.

How to Resolve?: Enter a valid parent as this parent has no child.

Sample Fail Response: 18

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<RemoveLine>
	<statusCode>622</statusCode>
	<description>FAIL</description>
	<errorDescription>This child is not associated with this parent.</errorDescription>
</RemoveLine>
</VcareOssApi>

Error Description: This child is not associated with this parent.

How to Resolve?: Enter a valid child as this child is not associated with the entered parent.

All the status codes are listed under the status code sections. Please click here to go to the status code.