8281 Tigrillo API User Guide

Tigrillo API User Guide
Document Reference: 8281
June 2017
Version: 12
Version Date Author Changes
Number
1 Mar 2015 John
Lindsay
2 Sep 2015 Sam Smith Branding updated
Updated to be used with 8314 Postman User Guide
3 Apr 2016 Sam Smith Branding Updated
4 June 2016 Sam Smith UnsuspendSIMs description updated
5 Aug 2016 Sam Smith Added ‘mappedMSISDN’ row to ‘getSIMs’
6 Aug 2016 Sam Smith Updated terminateSIMs request parameters
7 Sep 2016 Sam Smith Updated getSIMLastActivity explanations
8 Sep 2016 Sam Smith Updated introductions to include reference to
Postman app
9 Sep 2016 Sam Smith Added php cURL example
10 Mar 2017 Sam Smith Added an introduction
11 Jun 2017 Sam Smith Updated branding
12 Apr 2018 Sam Smith Added setSIMDetail section
Page 1
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
Eseye, AnyNet, AnyNet Secure and Eseye Logos are registered trademarks of Eseye Ltd © Eseye 2017 Limited.
All Rights Reserved. enquiries@eseye.com | eseye.com
Contents
1 Introduction ......................................................................................................................................... 3
1.1 Preparation of Eseye Account ................................................................................................ 3
2 Functions .............................................................................................................................................. 3
2.1 ping: ............................................................................................................................................. 3
2.2 getCookieName: ....................................................................................................................... 6
2.3 login: ........................................................................................................................................... 10
2.4 changePassword: .................................................................................................................... 15
2.5 getSIMs:...................................................................................................................................... 20
2.6 getSIMStateOptions ................................................................................................................ 27
2.7 setSIMState:............................................................................................................................... 32
2.8 activateSIMs: ............................................................................................................................ 38
2.9 suspendSIMs:............................................................................................................................. 48
2.10 unsuspendSIMs: ........................................................................................................................ 54
2.11 terminateSIMs: .......................................................................................................................... 59
2.12 setSIMDetail: ............................................................................................................................. 65
2.13 getSIMBilling: ............................................................................................................................. 69
2.14 getSIMLastActivity ................................................................................................................... 76
2.15 logout: ........................................................................................................................................ 84
3 Coding Examples.............................................................................................................................. 88
3.1 PHP cURL ................................................................................................................................... 88
4 FAQ ...................................................................................................................................................... 89
4.1 Versions of API .......................................................................................................................... 89
4.2 SIM States .................................................................................................................................. 89
4.3 General...................................................................................................................................... 90
Page 2
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
1 Introduction
The Tigrillo /SIAM API ties into the same data as the SIM Information and Account
Management portal, allowing access to the SIM information and altering the SIM status.
Many of the changes in SIM state can be altered through multiple functions, for example
setSIMState and activateSIMs can both activate SIM cards. This is to allow subtlety different
requests, take note of the parameters available when deciding upon which function to use.
1.1 Preparation of Eseye Account

When setting up your API the support team at Eseye will give you your portfolioID. You will
need this to login.
To access the Production API you will also need to supply the static IP address you wish to
access from.
This document is designed to enable developers to interface with the Tigrillo API offered by
Eseye.
This document uses the Postman app only as an example, the API is app agnostic. The
Postman User Guide can be found at https://www.eseye.com/wp-content/uploads/8314-
Postman-User-Guide.pdf.
2 Functions
2.1 ping:
This function tests whether the server running. To test the interface in Postman app use the
details shown below, to download a code example of this request use the Generate Code
button:
2.1.1 Production:
Request URL: https://siam.eseye.com/Japi/Tigrillo/ping
Command: ‘Post’
Parameters: Leave blank
Options: Leave as default
Text box: Leave blank
Click the blue ‘Send’ button.
Page 3
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.1.2 Staging:
Request URL: https://tigrillostaging.eseye.com/Japi/Tigrillo/ping
Command: ‘Post’
2.1.3 Responses:
All of these responses are when viewed in the pretty form (default setting).
2.1.3.1 Successful:
If your request is successful a response will display as follows:
“pong”
This indicates that the server is running.
2.1.3.2 Errors:
2.1.3.2.1 E0001 Invalid input - Syntax error, malformed JSON:
This error message will display as follows:
{
"status": {
"status": "ERR",
"code": "E0001",
"message": "Invalid input - Syntax error, malformed
JSON"
}
}
This indicates that some JSON text has been entered, delete any content in the text box.
Page 4
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.1.3.2.2 E0002 Function not recognised:
{
"status": {
"status": "ERR",
"code": "E0002",
"message": "Function not recognized"
}
}
This indicates that the Tigrillo/ping section of the Request URL was entered incorrectly.
2.1.3.2.3 E0003 API Version not recognised:

{
"status": {
"status": "ERR",
"code": "E0003",
"message": "API version not recognized"
}
}
This indicates that the ping section of the Request URL was not entered.
2.1.3.2.4 E0005 Invalid parameter:

{
"status":{
"status":"ERR",
"code":"E0005",
"message":"Invalid parameter - login"
}
}
Page 5
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.1.3.2.5 Could not get any response:
This indicates that either you are not connected to the internet or one or more of the
following sections of the Request URL were entered incorrectly. http ://
.eseye.com/
2.1.3.2.6 <!DOCTYPE html>:

This error message will begin as follows:
This indicates that one or more of the following sections of the Request URL were entered
incorrectly. siam tigrillostaging Japi/
2.2 getCookieName:
getCookieName returns the name of the HTTP cookie needed for sessions to be continued
without the need to log in each time. It does not require a user to be logged in, and it also
does not require any JSON formatted text. To test the interface in Postman app use the
details shown below, to download a code example of this request use the Generate Code
button:
Page 6
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.2.1 Production:
Request URL: https://siam.eseye.com/Japi/Tigrillo/getCookieName
Command: ‘Post’
2.2.2 Staging:
Request URL: https://tigrillostaging.eseye.com/Japi/Tigrillo/getCookieName
Command: ‘Post’
2.2.3 Responses:
2.2.3.1 Successful:
2.2.3.1.1 In default view, pretty form:
This will return "PHPSESSID".
2.2.3.1.2 In Cookies:
Click on the Cookies viewing option.
If asked to download the ‘Postman Interceptor’ follow the instructions in the Cookies section
in the Postman User Guide (url: https://www.eseye.com/wp-content/uploads/8314-Postman-
User-Guide.pdf ).
Postman displays the ‘Value’ of the cookie that matches the cookie value in the last
successful login.
Page 7
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.2.3.2 Errors:
All of these errors are when viewed in the pretty form (default setting).

{
"status": {
"status": "ERR",
"code": "E0001",
JSON"
}
}

{
"status": {
"status": "ERR",
"code": "E0002",
}
}
This indicates that the Tigrillo/getCookieName section of the Request URL was entered
incorrectly.

{
"status": {
"status": "ERR",
"code": "E0003",
}
}
This indicates that the getCookieName section of the Request URL was not entered.
Page 8
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
{
"status":{
"status":"ERR",
"code":"E0005",
}
}

.eseye.com/

Page 9
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.3 login:
This function logs the user on. To test the interface in Postman app use the details shown
below, to download a code example of this request use the Generate Code button:
2.3.1 Production:
Request URL: https://siam.eseye.com/Japi/Tigrillo/login
Command: ‘Post’
Options: ‘Body’, ‘Raw’, and ‘JSON (application/json)’
Text box: Enter the following JSON formatted text. Note replace the three examples with the
relevant information enclosed by speech marks.
{
"username" : "exampleusername" ,
"password" : "examplepassword" ,
"portfolioID" : "exampleportfolioid"
}
2.3.2 Staging:
Request URL: https://tigrillostaging.eseye.com/Japi/Tigrillo/login
Command: ‘Post’
Text box: enter JSON formatted text. Note replace the three examples with the relevant
information enclosed by speech marks.
{
"username" : "exampleusername" ,
"password" : "examplepassword" ,
"portfolioID" : "exampleportfolioid"
}
Page 10
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.3.3 Responses:
All of these responses are when viewed in the pretty form (default setting)
2.3.3.1 Successful:
{
"status": {
"errorCode": "",
"errorMessage": "",
"status": "OK"
},
"cookie": "88djk4qrg39m68lpdupkjiujo4 ",
"permissions": "UAFE",
"canActivate": "yes"
}
This indicates a successful login.
2.3.3.1.1 "status": "OK" row:

This indicates whether the attempt was successful: “OK” for success, “ERR” for unsuccessful.
2.3.3.1.2 “cookie” row:

This is an example, yours will be different to "88djk4qrg39m68lpdupkjiujo4".
The cookie stores your login details needed for the session to be continued without the need
to log again.
If you do not log out, but an attempt is made to log in, the previous user will be logged out,
regardless of whether the new login attempt is successful.
Note the system will only record an attempt to login if the function and JSON format text is
entered correctly.
2.3.3.1.3 “permissions” row:

This indicates the account type of the login, this dictates the amount of functions available.
The permissions are as follows:
Character Permission
F Finance
A Admin
U Standard user
L Logistics
T Technical
Page 11
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
Character Permission
E Engineering
All of the applicable permissions are indicated.
2.3.3.1.4 “canActivate” row:

This indicates whether the account is permitted to activate SIMs. It will display either yes or
no.
2.3.3.2 Errors:
2.3.3.2.1 E0000, Unknown username or password:
{
"status": {
"status": "ERR",
"code": "E0000",
"message": "Unknown username or password "
}
}
This indicates that your password was entered incorrectly.
2.3.3.2.2 E0001, Invalid input - Syntax error, malformed JSON:

{
"status": {
"status": "ERR",
"code": "E0001",
JSON"
}
}
This indicates that the JSON text was structured incorrectly. Check that your JSON text follows
the format described. Note this error can be received due to Microsoft Word style text being
entered, as some characters are slightly different between Microsoft Word and ASCII. To
avoid this, either type the text in directly, or configure Microsoft Word so that basic ASCII text
is entered. To do this, consult section 4.3.6.
Page 12
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.3.3.2.3 E0002, Function not recognised:
{
"status": {
"status": "ERR",
"code": "E0002",
}
}
This indicates that the Tigrillo/login section of the Request URL was entered incorrectly.

{
"status": {
"status": "ERR",
"code": "E0003",
}
}
This indicates that the login section of the Request URL was not entered.
2.3.3.2.5 E0100, Unknown username or password:

{
"status": {
"status": "ERR",
"code": "E0100",
"message": "Unknown username or password "
}
}
This indicates that one or both of your username, or portfolioID were entered incorrectly.
Page 13
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.3.3.2.6 F0000, No response provided:
{
"Status": "ERR",
"Code": "F0000",
"Message": "No response provided"
}
This indicates that the Request URL is missing the ‘s’ in https or that one or more of the fields
were entered incorrectly. Note this is the typing of the field name, for example "password"
might have been entered as "passwor".

.eseye.com/

Page 14
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.3.3.2.9 <!DOCTYPE HTML PUBLIC “-//IETF//BTB HTML 2.0//EN”>
This indicates that the IP Address that you are working from is not registered by Eseye.
Contact Eseye Support team to add a static IP Address.
2.4 changePassword:
This function changes the password for the account currently logged in. It requires the user to
be logged in. To test the interface in Postman app use the details shown below, to download
a code example of this request use the Generate Code button:
2.4.1 Production:
Request URL: https://siam.eseye.com/Japi/Tigrillo/changePassword
Command: ‘Post’
Text box: Enter the following JSON formatted text. Note replace the two examples with the
relevant information enclosed by speech marks. All passwords must be: minimum of 6 and a
maximum of 32 characters and contain one of each of the following: a digit, an uppercase
letter, and a lower case letter.
{
"currentPassword" : "examplepassword" ,
"newPassword" : "newexamplepassword"
}
Page 15
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.4.2 Staging:
Request URL: https://tigrillostaging.eseye.com/Japi/Tigrillo/changePassword
Command: ‘Post’
Text box: Enter the following JSON formatted text. Note replace the two examples with the
relevant information enclosed by speech marks. All passwords must be: minimum of 6 and a
maximum of 32 characters and contain one of each of the following: a digit, an uppercase
letter, and a lower case letter.
{
"currentPassword" : "examplepassword" ,
"newPassword" : "newexamplepassword"
}
2.4.3 Responses:
2.4.3.1 Successful:
{
"status": {
"status": "OK",
"errorCode": "",
"errorMessage": ""
}
}
Your password has now been changed.
Page 16
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.4.3.2 Errors:
{
"status": {
"status": "ERR",
"code": "E0001",
JSON"
}
}

{
"status": {
"status": "ERR",
"code": "E0002",
}
}
This indicates that the Tigrillo/changePassword section of the Request URL was entered
incorrectly.

{
"status": {
"status": "ERR",
"code": "E0003",
}
}
This indicates that the changePassword section of the Request URL was not entered.
Page 17
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
{
"status":{
"status":"ERR",
"code":"E0005",
"message":"Invalid parameter - currentPasswor"
}
}
This indicates that the parameter being reported is invalid. Either ‘currentPassword’ or
‘newPassword’ are misspelt or an additional parameter has been added. Correct the
spelling or delete the additional parameter in the JSON.
2.4.3.2.5 E0006 Permission denied:

{
"status": {
"status": "ERR",
"code": "E0006",
"message": "Permission denied"
}
}
This indicates that either cookies are not being stored correctly or you are not logged in. To
verify that the cookies are not causing the error follow section 2.2 of this document. To verify
that you are logged in follow section 2.3 of this document.
2.4.3.2.6 E0116 Invalid password:

{
"status": {
"status": "ERR",
"code": "E0116",
"message": "Invalid password"
}
}
This indicates that the new password does not meet the criteria specified (All passwords must
be: minimum of 6 and a maximum of 32 characters and contain one of each of the
following: a digit, an uppercase letter, and a lower case letter).
Page 18
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.4.3.2.7 E0126 Passwords don’t match:
{
"status": {
"status": "ERR",
"code": "E0126",
"message": "Passwords don’t match"
}
}
This indicates that the Request URL is missing the ‘s’ in https or that the currentPassword field
does not match your existing password.

.eseye.com/
Page 19
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.5 getSIMs:
This function returns a list of SIM data. It requires the user to be logged in. To test the interface
in Postman app use the details shown below, to download a code example of this request
use the Generate Code button:
2.5.1 Production:
Request URL: https://siam.eseye.com/Japi/Tigrillo/getSIMs
Command: ‘Post’
Text box: Enter the following JSON formatted text. Note replace the nine ‘null’s in the JSON as
required. For more information on the JSON fields see section 2.5.3 JSON fields.
{
"searchCriteria" : {
"state" : null ,
"group" : null ,
"tariff" : null ,
"matchString" : null ,
"matchType" : null ,
"matchFields" : null
} ,
"sortOrder" : null ,
"startRec" : null ,
"numRecs" : null
}
Page 20
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.5.2 Staging:
Request URL: https://tigrillostaging.eseye.com/Japi/Tigrillo/getSIMs
Command: ‘Post’
required. For more information on the JSON fields see section 2.5.3 JSON fields.
{
"searchCriteria" : {
"state" : null ,
"group" : null ,
"tariff" : null ,
"matchString" : null ,
"matchType" : null ,
"matchFields" : null
} ,
"startRec" : null ,
"numRecs" : null
}
2.5.3 JSON fields:

The fields (“state”, “group”, “tariff”, “matchString”, “matchType”, “matchFields”, “sortOrder”,
“StartRec”, and “numRecs”) are all optional. If you do not wish to use any of these search
criteria, enter null as the input (as shown in the examples, without speech marks). If you do
wish to use any of the fields to narrow the search criteria then ensure that null is replaced by
a value enclosed in speech marks.
If null is entered as input for all parameters, all SIMs will be returned, in ascending order of
ICCID number.
2.5.3.1 “state”:
This field determines which state of SIM cards will be displayed. The available options are;
“suspended”, “terminated”, and “provisioned”.
2.5.3.2 “group”:
This field determines which Group Name of SIM cards will be displayed. Group names can be
set for collections of SIMs when activating them using the activateSIMs function 2.8 or
through the SIAM portal.
Page 21
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.5.3.3 “tariff”:
This field determines which tariff ID of SIM cards will be displayed. Tariff ID are usually four
numerical digits in length (for example 2356).
2.5.3.4 “matchString”:
This field determines which string of information you want to match (i.e. receive responses
which match your string of information).
This field needs the “matchType” and “matchFields” to be filled.
2.5.3.5 “matchType”:
This field determines the type of match to be made, used in conjunction with the
“matchString” and “matchFields”. The options are: “S”, “E”, “C”, and “M”, these respectively
stand for: starts with…, ends with…, contains, and matches. If this field is entered incorrectly
then the entire estate of SIM cards will be returned.
2.5.3.6 “matchFields”:
This field determines the field of information to match, used in conjunction with the
“matchString” and “matchType”. Enter either the relevant Field or Indicator from the table
below:
Field Indicator
“FriendlyName” “F”
“MSISDN” “M”
“IMSI” “S”
“ICCID” “I”
“IMEI” “E”
“IP Address” “A”
If this field is entered incorrectly then the entire estate of SIM cards will be returned.
2.5.3.7 “sortOrder”:
This determines what factor the SIM cards will be ordered by. Enter either the relevant Field or
Indicator from the table below:
Sort by Indicator
“FriendlyName” “F”
“MSISDN” “M”
“IMSI” “S”
“ICCID” “I”
“IMEI” “E”
“IP Address” “A”
If this field is entered incorrectly then the SIM cards will not be sorted by an indicator.
Page 22
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.5.3.8 “startRec”:
This determines the number of the first SIM card to be returned (the records having been
ordered as you specified in sortOrder). The default is: null and “0”, they both display all of the
results, “1” doesn’t display the first result, “2” doesn’t display the first two results, and so on.
2.5.3.9 “numRecs”:
This determines how many SIM cards will be displayed. null displays all SIM cards, “1” displays
one and “2” displays two and so on.
2.5.4 Responses:
2.5.4.1 Successful:
{
"totRecs": 29,
"sims": [
{
"MSISDN": 447924165904,
"friendlyName": "SHIELD",
"ICCID": "8944538523005817658",
"ipAddress": "10.245.140.95",
"group": null,
"status": "provisioned",
"alert": "",
"controls": "SU"
}
],
"status": {
"status": "OK",
"errorCode": "",
"errorMessage": ""
}
}
2.5.4.1.1 “totalRecs” row:
This displays the number of records displayed.
2.5.4.1.2 “MSISDN” row:

This displays the Mobile Station International ISDN Number (MSISDN) of the SIM card.
Page 23
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.5.4.1.3 “friendlyName” row:
This displays the name assigned to help identify the SIM card. This can be altered in the SIAM
portal.
2.5.4.1.4 “ICCID” row:

This displays the integrated circuit card identifier (ICCID) of the SIM card.
2.5.4.1.5 "ipAddress" row:

This displays the Internet Protocol address, the unique string of numbers separated by full
stops.
2.5.4.1.6 “group” row:

This displays the name assigned to help identify a group of SIM cards. This can be altered in
the SIAM portal.
2.5.4.1.7 “status” row:

This displays the status of the SIM card. It will be either available, suspended, terminated, or
provisioned.
2.5.4.1.8 “alert” row:

This currently is not used to display any information.
2.5.4.1.9 “controls” row:

This displays whether the SIM card can be sent a control message. This is displayed as an S for
SMS, U for USSD, US for both USSD and SMS, and blank means neither are permitted.
2.5.4.1.10 "mappedMSISDN" row:

This displays the any foreign number mapped on to the SIM card.
Page 24
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.5.4.2 Errors:
{
"status": {
"status": "ERR",
"code": "E0001",
JSON"
}
}
the format described in 2.5 of this guide. Note this error can be received due to Microsoft
Word style text being entered, as some characters are slightly different between Microsoft
Word and ASCII. To avoid this, either type the text in directly, or configure Microsoft Word so
that basic ASCII text is entered. To do this, consult section 4.3.6.

{
"status": {
"status": "ERR",
"code": "E0002",
}
}
This indicates that the Tigrillo/getSIMs section of the Request URL was entered incorrectly.

{
"status": {
"status": "ERR",
"code": "E0003",
}
}
This indicates that the getSIMs section of the Request URL was not entered.
Page 25
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
{
"status":{
"status":"ERR",
"code":"E0005",
"message":"Invalid parameter - sortOrde"
}
}
This indicates that the parameter being reported is invalid. Either a parameter is misspelt or
an additional parameter has been added. Correct the spelling or delete the additional
parameter in the JSON.

{
"status": {
"status": "ERR",
"code": "E0006",
}
}

.eseye.com/
Page 26
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.6 getSIMStateOptions
This function returns a list of the possible states that a particular SIM card can be put into. It
requires the user to be logged in, and the ICCID of the SIM (this can be found using the
getSIMs function). To test the interface in Postman app use the details shown below, to
download a code example of this request use the Generate Code button:
2.6.1 Production:
Request URL: https://siam.eseye.com/Japi/Tigrillo/getSIMStateOptions
Command: ‘Post’
Text box: Enter the following JSON formatted text. Note replace the “input” with the relevant
ICCID enclosed by speech marks.
{
"ICCID" : "input"
}
Page 27
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.6.2 Staging:
Request URL: https://tigrillostaging.eseye.com/Japi/Tigrillo/getSIMStateOptions
Command: ‘Post’
Text box: Enter the following JSON formatted text. Note replace the “input” with the relevant
ICCID enclosed by speech marks.
{
"ICCID" : "input"
}
2.6.3 Responses:
2.6.3.1 Successful:
{
"status": {
"status": "OK",
"errorCode": "",
"errorMessage": ""
},
"stateOptions": [
{
"ID": "suspend",
"title": "Suspend SIM"
},
{
"ID": "terminate",
"title": "Terminate the SIM"
}
]
}
Page 28
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.6.3.1.1 State Options
2.6.3.1.1.1 “suspend” “Suspend SIM”
This indicates that the SIM card can be suspended, if suspended the SIM will stop connecting
to the network and continue to be billed for the service charge. This is instant and can be
reversed.
If suspend and terminate are returned together the SIM is active.
2.6.3.1.1.2 “terminate” “Terminate the SIM”

This indicates that the SIM card can be terminated, if terminated the SIM will stop connecting
to the network and will stop the service charge being billed (if the SIM is still in contract the
customer is liable for the rest of the service charges up until the end date of the contract).
This is not instant as it needs Eseye verification.
If suspend and terminate are returned together the SIM is active.
If active and terminate are returned together the SIM is suspended.
2.6.3.1.1.3 “active” “Reactivate the SIM”

This indicates that the SIM card can be activated, if activated the SIM will start connecting to
the network and could get billed for overage. This is instant and can be reversed.
If active and terminate are returned together the SIM is suspended.
2.6.3.1.1.4 "reason": "English language reason for why there are no options"
This indicates that the SIM card has no states that it can be altered into. It will state why the
SIM is unable to change state.
2.6.3.2 Errors:
{
"status": {
"status": "ERR",
"code": "E0001",
JSON"
}
}
the format described in. Note this error can be received due to Microsoft Word style text
being entered, as some characters are slightly different between Microsoft Word and ASCII.
Page 29
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
To avoid this, either type the text in directly, or configure Microsoft Word so that basic ASCII
text is entered. To do this, consult section 4.3.6.

{
"status": {
"status": "ERR",
"code": "E0002",
}
}
This indicates that the Tigrillo/getSIMStateOptions section of the Request URL was entered
incorrectly.

{
"status": {
"status": "ERR",
"code": "E0003",
}
}
This indicates that the getSIMStateOptions section of the Request URL was not entered.
2.6.3.2.4 E0004 Missing Parameter:

This error message will appear as below:
{
"status": {
"status": "ERR",
"code": "E0004",
"message": "Missing parameter - ICCID"
}
}
This indicates that the parameter being reported is absent or entered incorrectly, or that the
‘s’ in the ‘https’ section of the Request URL was not entered.
Page 30
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
{
"status":{
"status":"ERR",
"code":"E0005",
"message":"Invalid parameter - CCID"
}
}
This indicates that the parameter being reported is invalid. Either “ICCID” is misspelt or an
additional parameter has been added. Correct the spelling or delete the additional

{
"status": {
"status": "ERR",
"code": "E0006",
}
}
2.6.3.2.7 E0137 Invalid SIM no. provided:

{
"status": {
"status": "ERR",
"code": "E0137",
"message": "Invalid SIM no. provided"
}
}
This indicates that the ICCID is not one associated with the account currently logged in.
Page 31
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
.eseye.com/

2.7 setSIMState:
This function sets the state of a single SIM, allowing for suspension “suspend”, activation and
reactivation “active”, and termination “terminate”.
It does not allow for activation of a single SIM, for which the activateSIMs function 2.8 is
required.
If you wish the set a new state for multiple SIMs you should use one of suspendSIMs 2.9,
unsuspendSIMs 2.10, or terminateSIMs 2.11.
It requires the user to be logged in 2.3 and the ICCID of the SIM card. It also requires the state
the SIM card is to be changed into, to verify the possible states that a SIM can be altered to
follow section 2.6 getSIMStateOptions.
Page 32
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
To test the interface in Postman app use the details shown below, to download a code
example of this request use the Generate Code button:
2.7.1 Production:
Request URL: https://siam.eseye.com/Japi/Tigrillo/setSIMState
Command: ‘Post’
Text box: Enter the following JSON formatted text. Note replace the two “input”s with the
relevant information enclosed by speech marks. The possible options for “input” are:
“suspend”, “active”, and “terminate”.
{
"ICCID" : "input" ,
"state" : "input"
}
2.7.2 Staging:
Request URL: https://tigrillostaging.eseye.com/Japi/Tigrillo/setSIMState
Command: ‘Post’
{
"ICCID" : "input" ,
"state" : "input"
}
2.7.3 Responses:
Page 33
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.7.3.1 Successful:
{
"status": {
"status": "OK",
"errorCode": "",
"errorMessage": ""
}
}
The SIM is now in the state requested.
2.7.3.2 Errors:
{
"status": {
"status": "ERR",
"code": "E0001",
JSON"
}
}

{
"status": {
"status": "ERR",
"code": "E0002",
}
}
This indicates that the Tigrillo/getSIMs section of the Request URL was entered incorrectly.
Page 34
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
{
"status": {
"status": "ERR",
"code": "E0003",
}
}
This indicates that the setSIMState section of the Request URL was not entered.
2.7.3.2.4 E0004 Missing parameter:

{
"status": {
"status": "ERR",
"code": "E0004",
"message": "Missing parameter - state"
}
}

{
"status":{
"status":"ERR",
"code":"E0005",
"message":"Invalid parameter - CCID"
}
}
Page 35
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
{
"status": {
"status": "ERR",
"code": "E0006",
}
}

{
"status": {
"status": "ERR",
"code": "E0137",
}
}
This indicates that the ICCID number was entered incorrectly.
2.7.3.2.8 E0139 SIM cannot change state: SIM is pending termination:

{
"status": {
"status": "ERR",
"code": "E0139",
"message": "SIM cannot change state: SIM is pending
termination"
}
}
This indicates that the SIM card is awaiting termination, if this was requested accidently then
contact the Eseye Support Team immediately.
Page 36
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.7.3.2.9 E0140 Invalid state requested:
{
"status": {
"status": "ERR",
"code": "E0140",
"message": "Invalid state requested"
}
}
This indicates that the state requested was entered incorrectly. Either through a spelling error,
or because the state requested is unavailable for the SIM. To verify if the state is available for
the SIM use the getSIMStateOptions function 2.6.
2.7.3.2.10 E0142 Cannot activate SIM via this route

{
"status": {
"status": "ERR",
"code": "E0142",
"message": "Cannot activate SIM via this route"
}
}
This indicates that the SIM card cannot be activated over the API, please contact Eseye.

.eseye.com/
Page 37
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.7.3.2.13 SIM is pending activation:

This response means that a request has already been made for this SIM to be activated.
If you are using the Staging server, this request will not be executed, so if you wish to 'reset'
the SIM (in order that you can test the activation process again), contact Eseye.
2.8 activateSIMs:
This function activates single or multiple SIMs.
It requires the user to be logged in 2.3 and the ICCID of the SIM card. It also requires the Tariff
ID that the SIM card will be on (should it not have been pre provisioned). It also requires the
Friendly Name, Group Name, IMEI, and Device ID should you wish these to be assigned at
activation.
2.8.1 Production:
Production:
Request URL: https://siam.eseye.com/Japi/Tigrillo/activateSIMs
Command: ‘Post’
required. For more information on the JSON fields see section 2.8.3 JSON fields and the IMEI
field row does not end in a comma.
Page 38
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
{ "sims" : [ {
"ICCID" : "exampleICCID" ,
"friendlyName" : null ,
"IMEI" : null
} ,
{
"ICCID" : "exampleICCID2" ,
"friendlyName" : null,
"IMEI" : null
} ,
{
"IMEI" : null
} ] ,
"tariffID" : null ,
"group" : null ,
"device" : null
}
In the above example three SIM cards have been activated. More or fewer can be entered
as desired according to the following pattern:
{
"IMEI" : null
}
2.8.2 Staging:
Production:
Request URL: https://tigrillostaging.eseye.com/Japi/Tigrillo/activateSIMs
Command: ‘Post’
required. For more information on the JSON fields see section 2.8.3 JSON fields and the IMEI
field row does not end in a comma.
Page 39
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
{ "sims" : [ {
"IMEI" : null
} ,
{
"IMEI" : null
} ,
{
"IMEI" : null
} ] ,
"tariffID" : null ,
"group" : null ,
"device" : null
}
In the above example three SIM cards have been activated. More or fewer can be entered
as desired according to the following pattern:
{
"IMEI" : null
}
2.8.3 JSON fields:

The fields (“friendlyName”, “IMEI”, “tariffID”, “group”, and “device”) are all optional. If you do
not wish to alter any of these during activation, enter null as the input (as shown in the
examples, without speech marks). If you do wish to enter any of the fields to improve the
ability to identify the SIM card, ensure that null is replaced by the correct value enclosed in
speech marks.
2.8.3.1 “ICCID” – mandatory:

This field defines the SIM cards to be activated, it can be found by getSIMs 2.5. The ICCID is a
numerical value.It must be enclosed by speech marks.
2.8.3.2 “friendlyName” – optional:

This field defines the name assigned to the each SIM, it is used to help identify the SIM later.
Friendly Names must be less than 128 characters long and not include commas. It must be
enclosed by speech marks.
Page 40
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
Should you not wish to change a friendly name from what it is already set as or not use one
enter null, as seen in the example above.
Should you wish to remove an existing Friendly Name, enter an empty string, or two speech
marks: “”.
2.8.3.3 “IMEI” – optional:

This field defines the code of the device that the SIM card is being put into to help identify
the SIM later. This can be changed on the SIAM portal. It must be enclosed by speech marks.
Should you not wish to change an IMEI already set or not use one enter null, as seen in the
example above.
Should you wish to remove an existing IMEI, enter an empty string, or two speech marks: “”.
2.8.3.4 “tariffID” – optional:

This field defines the numerical code of the payment details of the SIM. It must be enclosed
by speech marks.
If every SIM already has a package assigned through preprovisioning, null can be entered,
as seen in the example above.
You are notified of your tariff ID during contract signing. Contact Eseye if you are unable to
remember it.
2.8.3.5 “group” – optional:

This field defines the name assigned to a number of SIMs, it is used to help identify the SIMs
later. It must be enclosed by speech marks.
Should you not wish to change a group name already set or not use one enter null, as seen
in the example above.
Should you wish to remove an existing group name, enter an empty string, or two speech
marks: “”.
2.8.3.6 “device” – optional:

This field defines the identifying code of the hardware model provided by Eseye, to help
identify the SIM later. This can be changed on the SIAM portal. It must be enclosed by
speech marks.
Should you wish to not change a device ID already set or not use one enter null, as seen in
the example above.
Should you wish to remove an existing IMEI, enter an empty string, or two speech marks: “”.
Page 41
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.8.4 Responses:
2.8.4.1 Successful:
{
"status": {
"status": "OK",
"errorCode": "",
"errorMessage": ""
},
"simStatuses": {
"8944538523009421515": {
"ICCID": "8944538523009421515",
"status": "OK"
},
"8944538523006861424": {
"ICCID": "8944538523006861424",
"status": "AUTO"
}
}
}
2.8.4.1.1 “status" row:
2.8.4.1.1.1 "OK":
This indicates that the request has been sent to the provisioning team, as displayed with
exampleICCID1.
2.8.4.1.1.2 "AUTO":
This indicates that the SIM has been scheduled for activation and should be on the network
within five minutes, as displayed with exampleICCID2.
2.8.4.2 Errors:
Please note that if an error message is received none of SIMs have been activated. Even if
the error code refers to one or only some of the SIMs.
Page 42
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.8.4.2.1 E0001 Invalid input ExampleICCID cannot be activated:
{
"status": {
"status": "ERR",
"errorCode": "See simErrors for details",
"errorMessage": ""
},
"simErrors": {
"8944538523007517298": "E0001:Invalid input -
8944538523007517298 cannot be activated "
}
}
This indicates that the SIM cannot be activated. To verify that the SIM can be activated
follow section 2.6 getSIMStateOptions. Note 8944538523007517298 is an example.
2.8.4.2.2 E0001 Invalid input ExampleICCID is not a valid SIM number:

{
"status": {
"status": "ERR",
"errorMessage": ""
},
"simErrors": {
"89445385230079800": "E0001:Invalid input -
89445385230079800 is not a valid SIM number"
}
}
This indicates that the ICCID was entered incorrectly. Note 89445385230079800 is an
example.
Page 43
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.8.4.2.3 E0001 Invalid input ExampleICCID is not an available SIM:
{
"status": {
"status": "ERR",
"errorMessage": ""
},
"simErrors": {
"89445385230079800": "E0001:Invalid input -
89445385230079800 is not an available SIM"
}
}
This indicates that the SIM is not available to be activated. To verify that the SIM can be
activated follow section 2.6 getSIMStateOptions. Note 89445385230079800 is an example.
2.8.4.2.4 E0001: Invalid input ExampleICCID requires Tariff:

{
"status": {
"status": "ERR",
"errorMessage": ""
},
"simErrors": {
"8944538523009250195": "E0001:Invalid input -
8944538523009250195 requires a tariff"
}
}
This indicates that a tariff ID needs to be assigned. Enter the correct tariff ID or if the Tariff ID
appears correct, or you have forgotten your tariff ID, contact Eseye.
2.8.4.2.5 E0001 Invalid input Syntax error, malformed JSON:

{
"status": {
"status": "ERR",
"code": "E0001",
JSON"
}
}
Page 44
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000

{
"status": {
"status": "ERR",
"code": "E0002",
}
}
This indicates that the Tigrillo/activateSIMs section of the Request URL was entered
incorrectly.

{
"status": {
"status": "ERR",
"code": "E0003",
}
}
This indicates that the activateSIMs section of the Request URL was not entered.

{
"status": {
"status": "ERR",
"code": "E0004",
"message": "Missing parameter - sims"
}
}
Page 45
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
{
"status":{
"status":"ERR",
"code":"E0005",
"message":"Invalid parameter - ICCI"
}
}
This indicates that the parameter being reported is invalid. Either “tariffID”, “group” or
“device” are misspelt or an additional parameter has been added. Correct the spelling or
delete the additional parameter in the JSON.

{
"status": {
"status": "ERR",
"code": "E0006",
}
}
2.8.4.2.11 E0132 Tariff ID is not valid:

{
"status": {
"status": "ERR",
"code": "E0132",
"message": "Invalid tariff selected"
}
}
This indicates that the Tariff ID was entered incorrectly. Check that the tariff ID entered is the
one agreed in your contract with Eseye. If the Tariff ID appears correct, or you have
forgotten your tariff ID, contact Eseye.
Page 46
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.8.4.2.12 E0133 Device type is not valid:
{
"status": {
"status": "ERR",
"code": "E0133",
"message": "Invalid device type selected"
}
}
This indicates that the Device ID was entered incorrectly. Contact Eseye if the Device ID
appears to be valid and you are still receiving this response.
2.8.4.2.13 E9998 System not available at this moment:

{
"status": {
"status": "ERR",
"code": "E9998",
"message": "System not available at this moment "
}
}
This indicates that the system is not currently running. Wait and then try again later.

.eseye.com/
Page 47
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.8.4.2.16 SIM is pending activation:

This response means that a request has already been made for this SIM to be activated.
If you are using the Staging server, this request will not be executed, so if you wish to 'reset'
the SIM (in order that you can test the activation process again), contact Eseye.
2.8.4.2.17 ”Status”: ”PAY”

{
"exampleICCID": {
"ICCID": "exampleICCID",
"status": "PAY"
"price" : "1.00"
"ccy" : "exampleCurrency"
}
}
This indicates that payment is required before the SIM can be activated, as displayed with
exampleICCID3. With this response two rows will appear; “price” indicates the amount
needed to pay, “ccy” indicates the currency requested.
To pay the outstanding amount log in to SIAM and use the Finance > Transactions > Make
Ad-hoc Payment By Credit Card.
2.9 suspendSIMs:
This function suspends multiple SIMs.
It requires the user to be logged in 2.3 and the ICCIDs of the SIM cards. It also requires the SIM
cards to be able to be suspended, to verify this use section 2.6 getSIMStateOptions.
Page 48
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.9.1 Production:
Request URL: https://siam.eseye.com/Japi/Tigrillo/suspendSIMs
Command: ‘Post’
Text box: Enter the following JSON formatted text. Note replace the “exampleICCID”s with
the relevant ICCIDs enclosed by speech marks and ensure that all rows end in a comma
except the last ICCID.
{ "sims" : [
"exampleICCID" ,
"exampleICCID" ,
"exampleICCID" ,
"exampleICCID"
]
}
2.9.2 Staging:
Request URL: https://tigrillostaging.eseye.com/Japi/Tigrillo/suspendSIMs
Command: ‘Post’
{ "sims" : [
"exampleICCID" ,
"exampleICCID" ,
"exampleICCID" ,
"exampleICCID"
]
}
Page 49
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.9.3 Responses:
2.9.3.1 Successful:
{
"status": {
"status": "OK",
"errorCode": "",
"errorMessage": ""
}
}
This indicates that all the listed SIMs have been suspended.
If the list of SIMs include some that are unsuccessful the response with display as follows:
{
"status": {
"status": "OK",
"errorCode": "",
"errorMessage": ""
},
"simStatuses": {
"894453852300680800": "E0137:Invalid SIM no.
provided"
}
Use the Errors below to verify the reasons for the errors.
2.9.3.2 Errors:
{
"status": {
"status": "ERR",
"code": "E0001",
JSON"
}
}
Page 50
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000

{
"status": {
"status": "ERR",
"code": "E0002",
}
}
This indicates that the Tigrillo/suspendSIMs section of the Request URL was entered incorrectly.

{
"status": {
"status": "ERR",
"code": "E0003",
}
}
This indicates that the suspendSIMSs section of the Request URL was not entered.

{
"status": {
"status": "ERR",
"code": "E0004",
}
}
Page 51
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
{
"status":{
"status":"ERR",
"code":"E0005",
"message":"Invalid parameter - ICCID"
}
}
This indicates that the parameter being reported is invalid. Ensure that “sims” is the only
parameter in the JSON text.

{
"status": {
"status": "ERR",
"code": "E0006",
}
}

{
"status": {
"status": "OK",
"errorCode": "",
"errorMessage": ""
},
"simStatuses": {
"89445385230980017": "E0137:Invalid SIM no. provided"
}
}
This indicates that the relevant ICCID was entered incorrectly.
Page 52
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.9.3.2.8 E0143: SIM cannot be suspended:
{
"status": {
"status": "OK",
"errorCode": "",
"errorMessage": ""
},
"simStatuses": {
"89445385230079800": "E0143:SIM cannot be suspended"
}
}
This indicates that the SIM cannot be suspended, to verify that the SIM can be suspended
follow section 2.6 getSIMStateOptions. Note 89445385230079800 is an example.

.eseye.com/

Page 53
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.10 unsuspendSIMs:
This function unsuspends multiple SIMs. It can only be achieved after the SIM card has been
suspended for two hours.
cards to be able to be unsuspended, to verify this use section 2.6 getSIMStateOptions.
2.10.1 Production:
Request URL: https://siam.eseye.com/Japi/Tigrillo/unsuspendSIMs
Command: ‘Post’
{ "sims" : [
"exampleICCID" ,
"exampleICCID" ,
"exampleICCID" ,
"exampleICCID"
]
}
2.10.2 Staging:
Request URL: https:// tigrillostaging.eseye.com/Japi/Tigrillo/unsuspendSIMs
Command: ‘Post’
Page 54
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
{ "sims" : [
"exampleICCID" ,
"exampleICCID" ,
"exampleICCID" ,
"exampleICCID"
]
}
2.10.3 Responses:
2.10.3.1 Successful:
{
"status": {
"status": "OK",
"errorCode": "",
"errorMessage": ""
}
}
This indicates that all the listed SIMs have been unsuspended.
{
"status": {
"status": "OK",
"errorCode": "",
"errorMessage": ""
},
"simStatuses": {
"8944538523005817781": "E0144:SIM cannot be
unsuspended",
"894453852300680800": "E0137:Invalid SIM no.
provided"
}
Use the errors codes below to verify the reasoning for the errors.
Page 55
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.10.3.2 Errors:
{
"status": {
"status": "ERR",
"code": "E0001",
JSON"
}
}

{
"status": {
"status": "ERR",
"code": "E0002",
}
}
This indicates that the Tigrillo/unsuspendSIMs section of the Request URL was entered
incorrectly.

{
"status": {
"status": "ERR",
"code": "E0003",
}
}
This indicates that the unsuspendSIMs section of the Request URL was not entered.
Page 56
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
{
"status":{
"status":"ERR",
"code":"E0004",
"message":"missing parameter - sims"
}
}

{
"status":{
"status":"ERR",
"code":"E0005",
"message":"Invalid parameter - ICCID"
}
}

{
"status": {
"status": "ERR",
"code": "E0006",
}
}
Page 57
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
{
"status": {
"status": "OK",
"errorCode": "",
"errorMessage": ""
},
"simStatuses": {
"89441226502644169": "E0137:Invalid SIM no. provided"
}
}
This indicates that either the relevant ICCID was entered incorrectly. Note
89441226502644169 is an example.
2.10.3.2.8 E0144 SIM cannot be unsuspended:

{
"status": {
"status": "OK",
"errorCode": "",
"errorMessage": ""
},
"simStatuses": {
"8944122650264416912": "E0144:SIM cannot be unsuspended"
}
}
This indicates that either: the SIM cannot be suspended, (to verify that the SIM can be
suspended follow section 2.6 getSIMStateOptions) or that either cookies are not being stored
correctly (to verify that the cookies are not causing the error follow section 2.2
getCookieName) or you are not logged in (to verify that you are successfully logged in follow
section 2.3 login).
Note 8944122650264416912 is an example.
Page 58
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
.eseye.com/
2.10.3.2.10 <!DOCTYPE html>:

2.11 terminateSIMs:
This function terminates multiple SIMs.
cards to be able to be terminated, to verify this use section 2.6 getSIMStateOptions.
Page 59
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.11.1 Production:
Request URL: https://siam.eseye.com/Japi/Tigrillo/terminateSIMs
Command: ‘Post’
{ "sims" : [
"exampleICCID" ,
"exampleICCID" ,
"exampleICCID"
]
}
2.11.2 Staging:
Request URL: https:// tigrillostaging.eseye.com/Japi/Tigrillo/terminateSIMs
Command: ‘Post’
{ "sims" : [
"exampleICCID" ,
"exampleICCID" ,
"exampleICCID"
]
}
Page 60
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.11.3 Responses:
{
"status": {
"status": "OK",
"errorCode": "",
"errorMessage": ""
}
}
This indicates that all the listed SIMs have been terminated.
{
"status": {
"status": "OK",
"errorCode": "",
"errorMessage": ""
},
"simStatuses": {
"8944538523005817781": "E0144:SIM cannot be
terminated",
"894453852300680800": "E0137:Invalid SIM no.
provided"
}
Use the errors codes below to verify the reasoning for the errors.
2.11.3.2 Errors:
{
"status": {
"status": "ERR",
"code": "E0001",
JSON"
}
}
Page 61
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000

{
"status": {
"status": "ERR",
"code": "E0002",
}
}
This indicates that the Tigrillo/terminateSIMs section of the Request URL was entered
incorrectly.

{
"status": {
"status": "ERR",
"code": "E0003",
}
}
This indicates that the terminateSIMs section of the Request URL was not entered.

{
"status": {
"status": "ERR",
"code": "E0004",
}
}
Page 62
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
{
"status":{
"status":"ERR",
"code":"E0005",
"message":"Invalid parameter - newPassword"
}
}

{
"status": {
"status": "ERR",
"code": "E0006",
}
}
2.11.3.2.7 E9998 System not available at this moment

{
"status": {
"status": "ERR",
"code": "E9998",
}
}
Page 63
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
.eseye.com/

Page 64
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.12 setSIMDetail:
This function updates the details of a single SIM.
It requires the user to be logged in 2.3 and the ICCID of the SIM card.
2.12.1 Production:
Request URL: https://siam.eseye.com/Japi/Siam/setSIMDetail
Command: ‘Post’
Text box: Enter the following JSON formatted text. Note replace the “input” with the ICCID
enclosed in speech marks and the 8 ‘null’s in the JSON as required. For more information on
the JSON fields see section 2.12.2 JSON fields.
{
"ICCID" : "input" ,
"field1" : null,
"field2" : null,
"field3" : null,
"field4" : null,
"field5" : null,
"group" : null,
"IMEI" : null
}
2.12.2 JSON fields:

The fields (“friendlyName”, “field1”, “field2”, “field3”, “field4”, “field5”, “group”, “IMEI”) are all
optional. If you do not wish to use any of these search criteria, enter null as the input (as
shown in the examples, without speech marks). If you do wish to set any of the fields ensure
that null is replaced by a value enclosed in speech marks.
If null is entered as an input for a parameter, the value will remain as previously set.
2.12.2.1 “friendlyName”, “field1”, “field2”, “field3”, “field4”, “field5”, “group”,

“IMEI”:
These fields set the associated free-form text fields associated with the SIM.
Page 65
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.12.3 Responses:
{
"status": {
"status": "OK",
"errorCode": "",
"errorMessage": ""
}
}
This indicates that all the listed SIMs have been updated.
2.12.3.2 Errors:
{
"status": {
"status": "ERR",
"code": "E0001",
JSON"
}
}

{
"status": {
"status": "ERR",
"code": "E0002",
}
}
This indicates that the Siam/setSIMDetail section of the Request URL was entered incorrectly.
Page 66
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
{
"status": {
"status": "ERR",
"code": "E0003",
}
}
This indicates that the setSIMDetail section of the Request URL was not entered.

{
"status": {
"status": "ERR",
"code": "E0004",
"message": "Missing parameter - ICCID"
}
}

{
"status": {
"status": "ERR",
"code": "E0006",
}
}
Page 67
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.12.3.2.6 E0137 Invalid SIM Number:
{
"status": {
"status": "ERR",
"code": "E0137",
}
}
This indicates that the SIM number (ICCID) entered was incorrect.
2.12.3.2.7 E9998 System not available at this moment:

{
"status": {
"status": "ERR",
"code": "E9998",
}
}

.eseye.com/
Page 68
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.13 getSIMBilling:
This function returns billing data for one SIM.
It requires the user to be logged in 2.3, the ICCIDs of the SIM cards.
2.13.1 Production:
Request URL: https://siam.eseye.com/Japi/Tigrillo/getSIMBilling
Command: ‘Post’
enclosed in speech marks and the six ‘null’s in the JSON as required. For more information on
{
"ICCID" : "input" ,
"startDate" : null ,
"endDate" : null ,
"startRec" : null ,
"numRecs" : null ,
"filter" : null
}
Page 69
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.13.2 Staging:
Request URL: https://tigrillostaging.eseye.com/Japi/Tigrillo/getSIMBilling
Command: ‘Post’
enclosed in speech marks and the six ‘null’s in the JSON as required. For more information on
{
"ICCID" : "input" ,
"startDate" : null ,
"endDate" : null ,
"startRec" : null ,
"numRecs" : null ,
"filter" : null
}
2.13.3 JSON fields:

The fields (“startDate”, “endDate”, “sortOrder”, “startRec”, “numRecs”, and “filter”) are all
optional. If you do not wish to use any of these search criteria, enter null as the input (as
shown in the examples, without speech marks). If you do wish to use any of the fields to
narrow the search criteria then ensure that null is replaced by a value enclosed in speech
marks.
2.13.3.1 “ICCID” – mandatory:

This field defines the SIM card for which the billing will be returned, it can be found by getSIMs
2.5. The input should be a number and enclosed by speech marks.
2.13.3.2 “startDate” – optional:

This field defines the beginning of the period to be searched for bills. The input should in the
format yyyy-MM-DD hh:mm:ss (year-month-date hour:minute:second, if no time is entered
then 00-00-00 is set as default) and enclosed in speech marks.
Should you wish to leave the search period as the most recent number of records (as defined
by “numRecs”) enter null, as seen in the example above.
Page 70
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.13.3.3 “endDate” – optional:
This field defines the end of the period to be searched for bills. The input should in the format
YYYY-MM-DD hh:mm:ss (year-month-date hour:minute:second, if no time is entered then 00-
00-00 is set as default) and enclosed in speech marks.
Should you wish to leave the search period as the most recent number of records (as defined
by “numRecs”) enter null, as seen in the example above.
2.13.3.4 “sortOrder” – optional:

This field defines the order that the results will be counted and presented in. The input is two
characters long, with no spaces and enclosed in speech marks.
For results ordered by activity the first character is an A, the second character is either A (for
ascending, alphabetical order) or D (for descending, reverse alphabetical order).
For results ordered by event the first character is an E, the second character is either A (for
ascending, oldest result first) or D (for descending, newest result first). Note if no date range
has been specified the results will be ordered in descending order only, regardless of the
second character.
Should you not wish to alter from the default ordering (event, descending) enter null, as seen
in the example above.
2.13.3.5 “startRec” – optional:

This field defines the first record to return, having been sorted by the sortOrder function. If you
wish the first record to be returned enter 0, with the second enter 1, all enclosed in speech
marks.
Should you not wish to alter from the default setting (returning the first record) enter null, as
seen in the example above.
2.13.3.6 “numRecs” – optional:

This field defines the amount of results listed. Enter the numerical value desired enclosed in
speech marks. If the number entered is more than the total amount of results available (after
the results have been sorted by the other parameters) then the maximum available will be
displayed.
Should you not wish to alter from the default setting (10 results) enter null, as seen in the
example above.
2.13.3.7 “filter” – optional:

This field defines the type of records that will be returned. Enter as many of the following
characters as desired:
Page 71
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
Character Returns
D Data
S SMS
V Voice
Enter the characters without spaces and enclosed in speech marks.
Should you not wish to alter from the default setting (all type of records returned) enter null,
as seen in the example above.
2.13.4 Responses:
{
"totalRecs": 1,
"recs": [
{
"activity": "Data",
"start": "2014-10-10 15:26:06",
"stop": "2014-10-10 15:33:39",
"description": "Zone 1 Data",
"quantity": 2236,
"price": "0.00",
"mcc": "208",
"mnc": "01"
"packageID": 1179
}
],
"status": {
"status": "OK",
"errorCode": "",
"errorMessage": ""
}
}
2.13.4.1.1 “totalRecs” row:
This displays the number of records displayed.
2.13.4.1.2 “activity” row:

This displays the type of activity in the event. It will be either Data, SMS, Voice or Other.
Page 72
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.13.4.1.3 “start” row:
This displays the beginning time of the event. This is displayed in the format yyyy-MM-DD
hh:mm:ss (year-month-date hour:minute:second).
2.13.4.1.4 “stop” row:

This displays the end time of the event, or if the event is instant like an SMS this will display null.
This is displayed in the format yyyy-MM-DD hh:mm:ss (year-month-date hour:minute:second).
2.13.4.1.5 “description” row:

This displays a text description of the activity. This is how the activity will be described in your
SIM contract.
2.13.4.1.6 “quantity” row:

This displays the amount of usage in the event. Data is measured in bytes, SMS by number of
messages, and voice is measured in seconds.
2.13.4.1.7 “price” row:

This displays the amount billed for the event. This is rounded to two decimal points and will be
in the currency specified in your SIM contract.
2.13.4.1.8 “mcc” row:

This displays the Mobile Country Code, this indicates the country that the device was in when
the event occurred. For more information: http://en.wikipedia.org/wiki/Mobile_country_code
2.13.4.1.9 “mnc” row:

This displays the Mobile Network Code, this indicates the network that the device was using
when the event occurred. For more information:
http://en.wikipedia.org/wiki/Mobile_country_code
2.13.4.1.10 “packageID” row:

This displays the reference number of the package that the SIM was on when the event
occurred.
Page 73
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.13.4.2 Errors:
{
"status": {
"status": "ERR",
"code": "E0001",
JSON"
}
}

{
"status": {
"status": "ERR",
"code": "E0002",
}
}
This indicates that the Tigrillo/ section of the Request URL was entered incorrectly.

{
"status": {
"status": "ERR",
"code": "E0003",
}
}
This indicates that the getSIMBilling section of the Request URL was not entered.
Page 74
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
This error message will indicate the parameter which is invalid. E.g.:
{
"status":{
"status":"ERR",
"code":"E0005",
"message":"Invalid parameter - startDat"
}
}

{
"status": {
"status": "ERR",
"code": "E0006",
}
}
This indicates you do not have permission to view the SIMBilling data. This indicates that either
cookies are not being stored correctly or you are not logged in. To verify that the cookies are
not causing the error follow section 2.2 of this document. To verify that you are logged in
follow section 2.3 of this document.

{
"status": {
"status": "ERR",
"code": "E0137",
}
}
This indicates that either the ICCID is not one associated with the account currently logged in
or that the ‘s’ in the ‘https’ section of the Request URL was not entered.
Page 75
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
.eseye.com/

2.14 getSIMLastActivity
This function returns the details of the last activity of the SIM card.
2.14.1 Production:
Request URL: https://siam.eseye.com/Japi/Tigrillo/getSIMLastActivity
Command: ‘Post’
Page 76
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
{
"ICCID" : "input"
}
2.14.2 Staging:
Request URL: https://tigrillostaging.eseye.com/Japi/Tigrillo/getSIMLastActivity
Command: ‘Post’
{
"ICCID" : "input"
}
2.14.3 Responses:
Page 77
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
{
"info": {
"LastLat": "51.241656",
"LastLon": "-0.59972",
"LastRadiusBytes": 13619,
"LastUsername": "user",
"LastSMS": null,
"LastVoice": null,
"LastMCC": "234",
"LastMNC": "33",
"LastLAI": "638",
"LastCI": "17153",
"LastMCCMNCDate": "2015-11-04 09:47:04",
"LastLAICIDate": "2015-11-04 09:47:04",
"LastRadiusStart": "2015-11-06 10:48:44",
"LastRadiusStop": "2015-11-06 13:13:22",
"MonthsRadiusBytes": 0,
"LastSMSMO": null,
"LastSMSMT": "2015-10-08 15:29:43",
"LastVoiceMO": null,
"LastVoiceMT": null,
"LastUSSDMO": null,
"LastUSSDMT": null,
"LastIMEI": "3568530503077111",
"LastIMEIDate": "2015-10-06 07:38:24",
"LastIMSI": null,
"LastIMSIDate": null,
"MonthsDataTotal": 3012608,
"MonthsDataDate": "2015-11-06 11:35:14",
"MonthsSMSTotal": 0,
"MonthsSMSDate": "2015-11-06 11:35:14",
"MonthsUSSDTotal": 0,
"MonthsUSSDDate": "2015-11-06 11:35:14",
"MonthsVoiceTotal": 0,
"MonthsVoiceDate": "2015-11-06 11:35:14",
"LastSMSMT_DR": null,
"LastNetworkName": "GB - EE"
},
"status": {
"status": "OK",
"errorCode": "",
"errorMessage": ""
}
Page 78
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
}
2.14.3.1.1 "LastLat" row:
This displays an estimate of the latitude of the SIM card last time it was active.
2.14.3.1.2 "LastLon" row:

This displays an estimate of the longitude of the SIM card last time it was active.
2.14.3.1.3 "LastRadiusBytes" row:

This displays the radius of the area that the last location is found within.
2.14.3.1.4 "LastUsername" row:

This is the last username used by the customer to recognise the device, not the SIAM/Tigrillo
login of the SIM card.
2.14.3.1.5 "LastSMS" row:

This should be ignored.
2.14.3.1.6 "LastVoice" row:

This should be ignored.
2.14.3.1.7 "LastMCC" row:

This displays the Mobile Country Code of the last mast used by the SIM card.
2.14.3.1.8 "LastMNC" row:

This displays the Mobile Network Code of the last mast used by the SIM card.
2.14.3.1.9 "LastLAI" row:

This displays the Local Area Identifier of the last mast used by the SIM card.
2.14.3.1.10 "LastCI" row:

This displays the cell identifier of the last mast used by the SIM card.
2.14.3.1.11 "LastMCCMNCDate" row:

This displays the date of the last Mobile Country Code and Mobile Network Code were
calculated.
2.14.3.1.12 "LastLAICIDate" row:

This displays the date of the last Local Area Identifier and Cell Identifier were calculated.
Page 79
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.14.3.1.13 "LastRadiusStart" row:
This displays the start date and time of the last data session.
2.14.3.1.14 "LastRadiusStop" row:

This displays the end date and time of the last data session.
2.14.3.1.15 "MonthsRadiusBytes" row:

This displays the amount of bytes used by the SIM card in the last month (prior to rounding for
billing).
2.14.3.1.16 "LastSMSMO" row:

This displays the date and time of the last SMS sent from the SIM card.
2.14.3.1.17 "LastSMSMT" row:

This displays the data and time of the last SMS sent to the SIM card.
2.14.3.1.18 "LastVoiceMO" row:

This displays the data and time of the last Voice call made from the SIM card.
2.14.3.1.19 "LastVoiceMT" row:

This displays the date and time of the last Voice call received by the SIM card.
2.14.3.1.20 "LastUSSDMO" row:

This displays the date and time of the last USSD message sent from the SIM card.
2.14.3.1.21 "LastUSSDMT" row:

This displays the date and time of the last USSD message sent to the SIM card.
2.14.3.1.22 "LastIMEI" row:

This displays the last IMEI of a modem used by the SIM card.
2.14.3.1.23 "LastIMEIDate" row:

This displays the date and time of the last IMEI reported by the SIM card.
2.14.3.1.24 "LastIMSI" row:

This displays the last IMSI used by the SIM card.
2.14.3.1.25 "LastIMSIDate" row:

This displays the date and time of the last IMSI reported by the SIM card.
Page 80
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.14.3.1.26 "MonthsDataTotal" row:
This displays the total of the data used over the last month (after rounding for billing).
2.14.3.1.27 "MonthsDataDate" row:

This displays the end date of the last month, used to calculate the data used.
2.14.3.1.28 "MonthsSMSTotal" row:

This displays the total SMSs used over the last month.
2.14.3.1.29 "MonthsSMSDate" row:

This displays the end date of the last month, used to calculate the SMSs used.
2.14.3.1.30 "MonthsUSSDTotal" row:

This displays the total USSDs used over the last month.
2.14.3.1.31 "MonthsUSSDDate" row:

This displays the end date of the last month, used to calculate the USSDs used.
2.14.3.1.32 "MonthsVoiceTotal" row:

This displays the total amount of voice calls used in the last month.
2.14.3.1.33 "MonthsVoiceDate" row:

This displays the end date of the last month, used to calculate the amount of voice calls
used.
2.14.3.1.34 "LastSMSMT_DR" row:

This displays the date and time of the last delivery receipt.
2.14.3.1.35 "LastNetworkName" row:

This displays a written description of the last network used by the SIM card.
Page 81
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.14.3.2 Errors:
{
"status": {
"status": "ERR",
"code": "E0001",
JSON"
}
}

{
"status": {
"status": "ERR",
"code": "E0002",
}
}
This indicates that the Tigrillo/terminateSIMs section of the Request URL was entered
incorrectly.

This error message will indicate the parameter which is invalid. E.g.:
{
"status":{
"status":"ERR",
"code":"E0005",
"message":"Invalid parameter - iccd"
}
}
Page 82
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
{
"status": {
"status": "ERR",
"code": "E0006",
}
}
This indicates you do not have permission to view the SIMBilling data. This indicates that either
cookies are not being stored correctly or you are not logged in. To verify that the cookies are
not causing the error follow section 2.2 of this document. To verify that you are logged in
follow section 2.3 of this document.

{
"status": {
"status": "ERR",
"code": "E0137",
}
}
This indicates that either the ICCID is not one associated with the account currently logged in
or that the ‘s’ in the ‘https’ section of the Request URL was not entered.

Page 83
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
.eseye.com/

2.15 logout:
This function logs the user off.
2.15.1 Production:
Request URL: https://siam.eseye.com/Japi/Tigrillo/logout
Command: ‘Post’
2.15.2 Staging:
Request URL: https://tigrillostaging.eseye.com/Japi/Tigrillo/logout
Command: ‘Post’
Page 84
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
2.15.3 Responses:
{
"status": {
"status": "OK",
"errorCode": "",
"errorMessage": ""
}
}
This indicates a successful logout. To use any functions except ping 2.1 and getCookieName
2.2 a successful login will be needed, follow login 2.3.
2.15.3.2 Errors:
{
"status": {
"status": "ERR",
"code": "E0001",
JSON"
}
}

{
"status": {
"status": "ERR",
"code": "E0002",
}
}
This indicates that the Tigrillo/logout section of the Request URL was entered incorrectly.

Page 85
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
{
"status": {
"status": "ERR",
"code": "E0003",
}
}
This indicates that the logout section of the Request URL was not entered.

{
"status":{
"status":"ERR",
"code":"E0005",
}
}

{
"status": {
"status": "ERR",
"code": "E0006",
}
}
This indicates you are already logged out. If you were expecting to be logged in still this
indicates that the cookies are not being stored. To verify that the cookies are causing the
error follow section 2.2 of this document.
Page 86
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
.eseye.com/

Page 87
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
3 Coding Examples
All of these examples are using the getSIMBilling
3.1 PHP cURL

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL =>
"https://siam.eseye.com/Japi/Tigrillo/getSIMBilling",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\r\n\"ICCID\" :
\"8944538523008137690\" ,\r\n \"startDate\" : null ,\r\n
\"endDate\" : null ,\r\n \"sortOrder\" : null ,\r\n
\"startRec\" : null ,\r\n \"numRecs\" : null ,\r\n \"filter\"
: null\r\n}",
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache",
"content-type: application/json",
"postman-token: 7e182090-8249-8359-4525-c4628ecd8cbc"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Page 88
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
4 FAQ
4.1 Versions of API
4.1.1 How do I use staging rather than production?
In order to use the staging server you should follow the Staging instructions, found at 2.X.2
rather than the Production instructions at 2.X.1 (where X refers to 1-13 depending on the
function).
4.1.2 Using specific versions of API

Where a specific version of the API is required, this may be requested by adding "v#" into the
URL.
e.g. To request the ping function for version 0.1 on the staging server, the request would use
URL
https://tigrillostaging.eseye.com/Japi/v0.1/Tigrillo/ping
Where no version number is explicitly requested, the latest version of the API processes the
request.
4.1.3 How to find the current version of the Production API

Please contact Eseye.
4.2 SIM States

4.2.1 How do I determine what state a SIM is currently in?
This can be achieved through the getSIMs function, consult 2.5.
4.2.2 How do I change the state of SIMs?

SIMs can only be activated using the activateSIMs function 2.8. One or more SIMs can be
activated at a time.
setSIMState 2.7 can be used to suspend, reactivate, and terminate a single SIM per request. If
you wish to alter the state of multiple SIMs use the relevant one of suspendSIMs 2.9,
unsuspendSIMS 2.10, _unsuspendSIMs:or terminateSIMS 2.11.
4.2.3 What does suspending a SIM do?

A suspended SIM will connect to the network and will be billed for the service charge.
Page 89
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
4.2.4 Can a suspended SIM be reprovisioned?
A suspended SIM is still provisioned. To re-enable services (i.e. Data, SMS and Voice), the SIM
should be unsuspended, use unusupendSIMs 2.10._unsuspendSIMs:
4.2.5 Does terminating a SIM stop it from being billed?

Yes, but if the SIM is still in contract then you are liable for the remaining cost of the contract.
4.2.6 Can a terminated SIM be reprovisioned?

Yes, a terminated SIM can be reprovisioned at any time.
4.3 General
4.3.1 How long is data retained for?
Two months, so customers must store historic data if they wish to retain it.
4.3.2 How do I determine the total number of activated SIMs for an

account?
The number of activated SIMs can be found through getSIMS 2.5.
4.3.3 How do I find a SIMs MSISDN?

The response to a getSIMs 2.5 request will show the MSISDN.
4.3.4 Can I be issued with test SIM cards/ICCIDs?

Unfortunately we are unable to issue test SIM cards. However, the staging server can be used
for testing, as although the staging server can be used to activate real cards, the requests
are not executed on the Home Location Register (HLR).
4.3.5 How many SIMs can be activated in a single call?

Although the system can handle more, the recommended limit is no more than 300 SIMs per
call, as internet latency issues may cause problems.
4.3.6 Configuring Word to use plain text

It is necessary to enter plain text to avoid a Syntax error. Conventionally, Microsoft Word does
not produce plain text, but it can be configured to do so.
Page 90
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000
4.3.6.1 For future use
4.3.6.1.1 Word 2013
Select Options from under the File Menu. Select Proofing, then Autocorrect Options. Click on
the "AutoFormat As You Type" tab, then uncheck "Straight quotes" with "Smart Quotes" under
the "Replace As You Type" tab.
4.3.6.1.2 Older versions of Word

Select AutoCorrect from under the Tools menu. Click on the "AutoFormat As You Type" tab,
then uncheck "Straight quotes" with "Smart Quotes" under the "Replace As You Type" tab.
4.3.6.2 To edit an existing document

4.3.6.2.1 Word 2013
Follow the steps described in 4.3.6.1.1 Then use Ctrl + H shortcut to use the Replace option.
Enter " in both the Find What and Replace With boxes, and click Replace All.
4.3.6.2.2 Older versions of Word

Follow the steps described in 4.3.6.1.2. Then use Ctrl + H shortcut to use the Replace option.
Enter " in both the Find What and Replace With boxes, and click Replace All.
Page 91
+ 44 1483 802501 | +1 512-813-0599 | +27 87 551 8200 | +33 9 87 67 53 36 | +61 8 9551 5200 | +61 400 435 1000

8281 Tigrillo API User Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

8281 Tigrillo API User Guide

Uploaded by

Copyright:

Available Formats

Tigrillo API User Guide

Document Reference: 8281

1.1 Preparation of Eseye Account

Parameters: Leave blank

Options: Leave as default

Text box: Leave blank

Click the blue ‘Send’ button.

Parameters: Leave blank

Options: Leave as default

Text box: Leave blank

Click the blue ‘Send’ button.

This indicates that the server is running.

2.1.3.2.3 E0003 API Version not recognised:

2.1.3.2.4 E0005 Invalid parameter:

2.1.3.2.6 <!DOCTYPE html>:

Parameters: Leave blank

Options: Leave as default

Text box: Leave blank

Click the blue ‘Send’ button.

Parameters: Leave blank

Options: Leave as default

Text box: Leave blank

Click the blue ‘Send’ button.

2.2.3.2.1 E0001 Invalid input - Syntax error, malformed JSON:

2.2.3.2.2 E0002 Function not recognised:

2.2.3.2.3 E0003 API Version not recognised:

2.2.3.2.5 Could not get any response:

2.2.3.2.6 <!DOCTYPE html>:

Parameters: Leave blank

Options: ‘Body’, ‘Raw’, and ‘JSON (application/json)’

Parameters: Leave blank

Options: ‘Body’, ‘Raw’, and ‘JSON (application/json)’

2.3.3.1.1 "status": "OK" row:

2.3.3.1.2 “cookie” row:

2.3.3.1.3 “permissions” row:

The permissions are as follows:

2.3.3.1.4 “canActivate” row:

2.3.3.2.2 E0001, Invalid input - Syntax error, malformed JSON:

2.3.3.2.4 E0003 API Version not recognised:

2.3.3.2.5 E0100, Unknown username or password:

2.3.3.2.7 Could not get any response:

2.3.3.2.8 <!DOCTYPE html>:

Parameters: Leave blank

Options: ‘Body’, ‘Raw’, and ‘JSON (application/json)’

Parameters: Leave blank

Options: ‘Body’, ‘Raw’, and ‘JSON (application/json)’

2.4.3.2.2 E0002 Function not recognised:

2.4.3.2.3 E0003 API Version not recognised:

2.4.3.2.5 E0006 Permission denied:

2.4.3.2.6 E0116 Invalid password:

2.4.3.2.8 Could not get any response:

Parameters: Leave blank

Options: ‘Body’, ‘Raw’, and ‘JSON (application/json)’

Parameters: Leave blank

Options: ‘Body’, ‘Raw’, and ‘JSON (application/json)’

2.5.3 JSON fields:

This field needs the “matchType” and “matchFields” to be filled.

2.5.4.1.2 “MSISDN” row:

2.5.4.1.4 “ICCID” row:

2.5.4.1.5 "ipAddress" row:

2.5.4.1.6 “group” row:

2.5.4.1.7 “status” row:

2.5.4.1.8 “alert” row:

2.5.4.1.9 “controls” row: