AddActivityLog

This XML API is used to add activity log on the customer's account.

End Point https://www.vcareapi.com/vcareOssApi/AddActivityLog/
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.
CUSTOMER ID string 123456 Required Auto generated customer account number. This is returned in GetCustomerInfo Numeric
ACTIVITY TYPE string Handover Required Activity type which you want to action perform. Like : Handover, Create Customer, Paybill etc.
ACTIVITY DESCRIPTION string This is an activity description Required These are the activity description which you want to le ave on the account Max 1000 characters
STATUS string success Optional this is the action status like: success,fail value must be success or fail
SOURCE string API Optional This is the source where the API. This could be API, TABLET, IVR etc.
AGENTID string John Doe Required This is the Telgoo5 user id.For the Agent/Employee who is sending the API request.
AGENTPASSWORD string JohnDoe 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>Vcarecorporation</VENDORID>
	<USERNAME>Vcarecorporation</USERNAME>
	<PASSWORD>Vcarecorporation</PASSWORD>
	<PIN>Vcarecorporation</PIN>
	<REFERENCENUMBER>11111</REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
<ADDACTIVITYLOG>
	<CUSTOMERID></CUSTOMERID>
	<ACTIVITYTYPE></ACTIVITYTYPE>
	<ACTIVITYDESCRIPTION></ACTIVITYDESCRIPTION>
	<STATUS>SUCCESS</STATUS>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
</ADDACTIVITYLOG>
</VCAREOSS>
</VCAREOSSAPI>
List of status code, description and resolution.
Status Code Description How to Resolve?
00 SUCCESS SUCCESS
13 Password is invalid. Provide a valid Password.
16 Vendor not found. Wrong credentials. Please enter valid vendor credentials.
26 Note Type is invalid. Provide a valid Note Type.
163 Data not inserted due to some technical reason. Data not inserted due to some technical reason. Please try after some time.
226 Customer ID is required. Please provide Customer ID.
321 Customer not found. Customer is not found.
356 Agent ID cannot be blank. Please provide Agent ID as it cannot be blank.
599 Type should not be blank. Provide a valid Type. Type should not be blank.
670 Description should not be blank. Provide a valid Description. Description should not be blank.
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>11111</referenceNumber>
    </credentials>
 <GetCustomerInfo>
    <AddNotes>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <lastInsertedId>5910675</lastInsertedId>
    </AddNotes>
</VcareOssApi>

SUCCESS

<lastInsertedId>5910675</lastInsertedId> This is the Note ID for the note added for reference.

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>
	<AddNotes>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</AddNotes>
</VcareOssApi>
Error Description: Password is invalid.
How to Resolve?: Provide a valid Password.
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>
	<AddNotes>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</AddNotes>
</VcareOssApi>
Error Description: Vendor not found. Wrong credentials.
How to Resolve?: Please enter valid vendor credentials.
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>
	<AddNotes>
	<statusCode>26</statusCode>
	<description>FAIL</description>
	<errorDescription>Note Type is invalid.</errorDescription>
</AddNotes>
</VcareOssApi>
Error Description: Note Type is invalid.
How to Resolve?: Provide a valid Note Type.
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>
	<AddNotes>
	<statusCode>163</statusCode>
	<description>FAIL</description>
	<errorDescription>Data not inserted due to some technical reason.</errorDescription>
</AddNotes>
</VcareOssApi>
Error Description: Data not inserted due to some technical reason.
How to Resolve?: Data not inserted due to some technical reason. Please try after some time.
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>
	<AddNotes>
	<statusCode>226</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is required.</errorDescription>
</AddNotes>
</VcareOssApi>
Error Description: Customer ID is required.
How to Resolve?: Please provide Customer 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>
	<AddNotes>
	<statusCode>321</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer not found.</errorDescription>
</AddNotes>
</VcareOssApi>
Error Description: Customer not found.
How to Resolve?: Customer is not found.
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>
	<AddNotes>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</AddNotes>
</VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID as it cannot 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>
	<AddNotes>
	<statusCode>599</statusCode>
	<description>FAIL</description>
	<errorDescription>Type should not be blank.</errorDescription>
</AddNotes>
</VcareOssApi>
Error Description: Type should not be blank.
How to Resolve?: Provide a valid Type. Type should not be blank.
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>
	<AddNotes>
	<statusCode>670</statusCode>
	<description>FAIL</description>
	<errorDescription>Description should not be blank.</errorDescription>
</AddNotes>
</VcareOssApi>
Error Description: Description should not be blank.
How to Resolve?: Provide a valid Description. Description should not be blank.

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