Manage Manage Plan Type

This API is used to take the Manage Plan Type.

End Point https://www.vcareapi.com/vcareOssApi/ManagePlanType/
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.
MODE String ADD Required ADD = Saved plan type. UPDATE = Update plan type. ADD,UPDATE
PLAN TYPE NAME string 123456 Conditional This is the name of the plan. OnlyEnglish alphabet letters, space, apostrophe, Accent Grave ("`") and hyphen.Max length - 50 symbols.Space characters at the start or end of the name the space should be cut off.
Required if ACTION="ADD"
STATE string MD Conditional Plans in Telgoo5 is configured by state. This is the state for the plan you would like to check. State should be standard abbreviated form.
Required if ACTION="ADD"
PLAN ID string 1315 Conditional This is the plan id on which the ESN/SIM was activated. This ID can be obtained using another api called GetPlanService. Required if ACTION="ADD"
STATUS string 1/0 Optional 1 Required if STATUS="1" Active or STATUS="0" Inactive
PLANTYPE ID Numeric 28 Conditional Required if ACTION="UPDATE"
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 do not 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>
	<MANAGEPLANTYPE>
		<MODE></MODE>
		<PLANTYPENAME></PLANTYPENAME>
		<STATE></STATE>
		<PLANID></PLANID>
		<STATUS></STATUS>
		<PLANTYPEID></PLANTYPEID>
		<AGENTID></AGENTID>
		<AGENTPASSWORD></AGENTPASSWORD>
		<SOURCE></SOURCE>
	</MANAGEPLANTYPE>
</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.
118 State is required. State cannot be blank. You should enter a valid State.
167 Plan ID is required. Please provide a Plan ID.
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.
547 Mode is required. Provide a correct Mode. Mode is mandatory.
548 Mode should be ADD and UPDATE. Chose Mode between ADD or UPDATE. ADD or UPDATE is required for Mode.
607 Plan Type ID is required. Please enter a Plan Type ID. Plan Type ID should not be blank.
608 Invalid Plan Type ID. Please provide a valid Plan Type ID. Given value is invalid for Plan Type ID.
612 Plan Type Name is required. Please provide a valid Plan Type Name. Given value is not available in system for Plan Type Name.
613 Status should be 0 (Inactive) OR 1 (Active) Only. Provide correct Status. Status should be 0 (Inactive) OR 1 (Active) Only.
637 Currently given Agent ID user group don't have 'Manage Plan Type (PC623)' privilege settings in order to perform this action. Please check privilege settings in order to perform this action.
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>11111111111</referenceNumber>
    </credentials>
    <ManagePlanType>
		<statusCode>00</statusCode>
		<description>SUCCESS</description>
		<errorDescription>SUCCESS</errorDescription>
		<plantype_id></plantype_id>
		<plan_type_name></plan_type_name>
  </ManagePlanType>
</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>
<ManagePlanType>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</ManagePlanType>
</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>
<ManagePlanType>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</ManagePlanType>
</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>
<ManagePlanType>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</ManagePlanType>
</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>
<ManagePlanType>
	<statusCode>118</statusCode>
	<description>FAIL</description>
	<errorDescription>State is required.</errorDescription>
</ManagePlanType>
</VcareOssApi>
Error Description: State is required.
How to Resolve?: State cannot be blank. You should enter a valid State.
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>
<ManagePlanType>
	<statusCode>167</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan ID is required.</errorDescription>
</ManagePlanType>
</VcareOssApi>
Error Description: Plan ID is required.
How to Resolve?: Please provide a Plan ID.
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>
<ManagePlanType>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</ManagePlanType>
</VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID as it cannot 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>
<ManagePlanType>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</ManagePlanType>
</VcareOssApi>
Error Description: Invalid Source.
How to Resolve?: Please provide a valid Source. Given value is invalid for Source.
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>
<ManagePlanType>
	<statusCode>547</statusCode>
	<description>FAIL</description>
	<errorDescription>Mode is required.</errorDescription>
</ManagePlanType>
</VcareOssApi>
Error Description: Mode is required.
How to Resolve?: Provide a correct Mode. Mode is mandatory.
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>
<ManagePlanType>
	<statusCode>548</statusCode>
	<description>FAIL</description>
	<errorDescription>Mode should be ADD and UPDATE.</errorDescription>
</ManagePlanType>
</VcareOssApi>
Error Description: Mode should be ADD and UPDATE.
How to Resolve?: Chose Mode between ADD or UPDATE. ADD or UPDATE is required for Mode.
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>
<ManagePlanType>
	<statusCode>607</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan Type ID is required.</errorDescription>
</ManagePlanType>
</VcareOssApi>
Error Description: Plan Type ID is required.
How to Resolve?: Please enter a Plan Type ID. Plan Type ID should not be blank.
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>
<ManagePlanType>
	<statusCode>608</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Plan Type ID.</errorDescription>
</ManagePlanType>
</VcareOssApi>
Error Description: Invalid Plan Type ID.
How to Resolve?: Please provide a valid Plan Type ID. Given value is invalid for Plan Type ID.
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>
<ManagePlanType>
	<statusCode>612</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan Type Name is required.</errorDescription>
</ManagePlanType>
</VcareOssApi>
Error Description: Plan Type Name is required.
How to Resolve?: Please provide a valid Plan Type Name. Given value is not available in system for Plan Type Name.
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>
<ManagePlanType>
	<statusCode>613</statusCode>
	<description>FAIL</description>
	<errorDescription>Status should be 0 (Inactive) OR 1 (Active) Only.</errorDescription>
</ManagePlanType>
</VcareOssApi>
Error Description: Status should be 0 (Inactive) OR 1 (Active) Only.
How to Resolve?: Provide correct Status. Status should be 0 (Inactive) OR 1 (Active) Only.
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>
<ManagePlanType>
	<statusCode>637</statusCode>
	<description>FAIL</description>
	<errorDescription>Currently given Agent ID user group don't have 'Manage Plan Type (PC623)' privilege settings in order to perform this action.</errorDescription>
</ManagePlanType>
</VcareOssApi>
Error Description: Currently given Agent ID user group don't have 'Manage Plan Type (PC623)' privilege settings in order to perform this action.
How to Resolve?: Please check privilege settings in order to perform this action.

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