Import the client for TASQ.
URL:
https://jobapi.tasq.com.au/api/Job/ImportClient
Supports:
POST.
Attribute Details:
Attribute Details:
| Company Validate Info | (object) | must |
| Login Name | (string) | |
| Client IP | (string) | |
| Password | (string) | |
| Mobile Device Token | (string) | |
| Web Api TOKEN | (Guid) | |
| Import Client View | (object) | |
| Client Name | (string) (200) | Must |
| Job Contact Title
Mr/Ms/Mrs/Miss |
(string) (50) | optional |
| Job Contact First Name | (string) (200) | optional |
| Job Contact Last Name | (string) (200) | optional |
| Job Contact Phone | (string) (50) | optional |
| Job Contact Mobile | (string) (50) | optional |
| Job Contact Fax | (string) (50) | optional |
| Job Contact Email | (string) (100) | optional |
| Is Same As Job Contact | (bool) | |
| Billing Contact Title
Mr/Ms/Mrs/Miss |
(string) (50) | optional |
| Billing Contact First Name | (string) (200) | optional |
| Billing Contact Last Name | (string) (200) | optional |
| Billing Contact Phone | (string) (50) | optional |
| Billing Contact Mobile | (string) (50) | optional |
| Billing Contact Fax | (string) (50) | optional |
| Billing Contact Email | (string) (100) | optional |
| Memos | (string) | optional |
| Job Address | (string) (200) | optional |
| Job Address Line2 | (string) (200) | optional |
| Job City | (string) (100) | optional |
| Job State
ACT/NSW/NT/TAS/QLD/SA/VIC/WA |
(string) (50) | optional |
| Job Postal Code | (string) (50) | optional |
| Job Country | (string) (50) | must |
| Is Same As Job Address | (bool) | |
| Billing Address | (string) (200) | optional |
| Billing Address Line 2 | (string) (200) | optional |
| Billing City | (string) (100) | optional |
| Billing State
ACT/NSW/NT/TAS/QLD/SA/VIC/WA |
(string) (50) | optional |
| Billing Postal Code | (string) (50) | optional |
| Billing Country | (string) (50) | must |
| ABN | (string) (20) | optional |
| Default Sales Discount | (decimal) (5,2) | Optional |
| BSB Number | (string) (7) | Optional |
| Bank Account Number | (string) (30) | Optional |
| Bank Account Name | (string) (100) | Optional |
| Statement Text | (string) (30) | Optional |
| Payment Memo | (string) | Optional |
| Default Sales Tax Code Name | (string)(200) | Optional |
Example JSON POST data:
{
"CompanyValidateInfo": {
"ClientIP": null,
"LoginName": "testapi@tasq.com.au",
"MobileDeviceToken": null,
"Password": "test123.",
"WebApiTOKEN": "b3b777b0-c7af-458d-be64-b3d6d760177f"
},
"ImportClientViewList": [{
"ClientName": "testClient1",
"JobContactTitle": "Mr",
"JobContactFirstName": "testFirstName",
"JobContactLastName": "testLastName",
"JobContactPhone": "323243545",
"JobContactFax": "323243545",
"JobContactMobile": "411208787",
"JobContactEmail": "test@testEmail.com",
"IsSameAsJobContact": "YES",
"BillingContactTitle": "",
"BillingContactFirstName": "",
"BillingContactLastName": "",
"BillingContactPhone": "",
"BillingContactMobile": "",
"BillingContactEmail": "",
"BillingContactFax": "",
"Memos": "testMemo",
"JobAddress": "7/30 ashted rd",
"JobAddressLine2": "",
"JobCity": "Box Hill",
"JobState": "VIC",
"JobPostalCode": "3128",
"JobCountry": "Australia",
"IsSameAsJobAddress": "YES",
"BillingAddress": "",
"BillingAddressLine2": "",
"BillingCity": "",
"BillingState": "",
"BillingPostalCode": "",
"BillingCountry": "",
"ABN": "53 004 085 616",
"DefaultSalesTaxCodeName": "GGGH",
"DefaultSalesDiscount": "20",
"BSBNumber": "123-456",
"BankAccountNumber": "12345678",
"BankAccountName": "testBankAccountName",
"StatementText": "testStatementText",
"PaymentMemo": ""
}, {
"ClientName": "testClient2",
"JobContactTitle": "Mr",
"JobContactFirstName": "testFirstName",
"JobContactLastName": "testLastName",
"JobContactPhone": "323243545",
"JobContactFax": "323243545",
"JobContactMobile": "411208787",
"JobContactEmail": "test@testEmail.com",
"IsSameAsJobContact": "YES",
"BillingContactTitle": "",
"BillingContactFirstName": "",
"BillingContactLastName": "",
"BillingContactPhone": "",
"BillingContactMobile": "",
"BillingContactEmail": "",
"BillingContactFax": "",
"Memos": "testMemo",
"JobAddress": "7/30 ashted rd",
"JobAddressLine2": "",
"JobCity": "Box Hill",
"JobState": "VIC",
"JobPostalCode": "3128",
"JobCountry": "Australia",
"IsSameAsJobAddress": "YES",
"BillingAddress": "",
"BillingAddressLine2": "",
"BillingCity": "",
"BillingState": "",
"BillingPostalCode": "",
"BillingCountry": "",
"ABN": "53 004 085 616",
"DefaultSalesTaxCodeName": "GGGH",
"DefaultSalesDiscount": "20",
"BSBNumber": "123-456",
"BankAccountNumber": "12345678",
"BankAccountName": "testBankAccountName",
"StatementText": "testStatementText",
"PaymentMemo": ""
}]
}
Return Value:
{
"ActionCode": "ImportClient",
"IsSuccessed": "YES",
"ErrorMessage": "2 of Client have been successfully Imported !",
"ReturnData": ""
}
C# Sample Code
public static string ImportClient (string Url ,string content)
{
string result = "";
HttpWebRequest req = (HttpWebRequest)WebRequest.Create(Url);
req.Method = "POST";
req.ContentType = "application/json";
#region Add Post Param
byte[] data = Encoding.UTF8.GetBytes(content);
req.ContentLength = data.Length;
using (Stream reqStream = req.GetRequestStream())
{
reqStream.Write(data, 0, data.Length);
reqStream.Close();
}
#endregion
HttpWebResponse resp = (HttpWebResponse)req.GetResponse();
Stream stream = resp.GetResponseStream();
using (StreamReader reader = new StreamReader(stream, Encoding.UTF8))
{
result = reader.ReadToEnd();
}
return result;
}
Javascript
function ImportClient () {
$.ajax({
type: "Post",
url: " https://jobapi.tasq.com.au/api/Job/ImportClient",
data: {
…
},
dataType: "json",
success: function (data) {
console.dir(data)
},
error: function (e) {
console.dir(e)
}
});
}
Java Sample Code
private static void ImportClient(String json){
try {
URL url = new URL("https://jobapi.tasq.com.au/api/Job/ImportClient ");
HttpURLConnection con = (HttpURLConnection)url.openConnection();
con.setRequestMethod("POST");
con.setRequestProperty("Content-Type", "application/json; charset=utf-8");
con.setRequestProperty("Accept", "application/json");
con.setDoInput(true);
con.setDoOutput(true);
con.setUseCaches(false);
con.setRequestProperty("Connection", "Keep-Alive");
if (json != null){
byte[] writeBytes = json.getBytes("utf-8");
OutputStream outputStream = con.getOutputStream();
outputStream.write(writeBytes,0, writeBytes.length);
outputStream.flush();
outputStream.close();
}
if (con.getResponseCode() == HttpURLConnection.HTTP_OK){
InputStreamReader in = new InputStreamReader(con.getInputStream());
BufferedReader br = new BufferedReader(in);
StringBuilder response = new StringBuilder();
String responseLine = null;
while ((responseLine = br.readLine()) != null){
response.append(responseLine.trim());
}
System.out.println(response.toString());
}
} catch (IOException e) {
e.printStackTrace();
}
}
Swift Sample Code
func ImportClient ()
{
let client: Client = Client()
let UrlString = TASQSampleCommonLibrary.TASQApiUrl + "Job/ImportClient"
let loginDetail: LoginDetail = LoginDetail()
var parameters = [String:AnyObject]()
var arrayData = [String:AnyObject]()
arrayData ["WebApiTOKEN"] = TASQSampleCommonLibrary.TASQApiTOKEN as AnyObject?
arrayData ["LoginName"] = loginDetail.LoginEmail! as AnyObject?
arrayData ["Password"] = loginDetail.LoginPassword! as AnyObject?
arrayData ["ClientIP"] = TASQSampleCommonLibrary.getIPAddresses() as AnyObject?
arrayData ["MobileDeviceToken"] = TASQSampleCommonLibrary.getMobileDeviceToken() as AnyObject?
parameters["CompanyValidateInfo"] = arrayData as AnyObject?
var clientArrayData = [String:String]()
clientArrayData["ClientID"] = (client.ClientID != nil) ? client.ClientID : ""
clientArrayData["ClientName"] = (client.ClientName != nil) ? client.ClientName : ""
clientArrayData["JobContactTitle"] = (client.JobContactTitle != nil) ? client.JobContactTitle : ""
clientArrayData["JobContactFirstName"] = (client.JobContactFirstName != nil) ? client.JobContactFirstName : ""
clientArrayData["JobContactLastName"] = (client.JobContactLastName != nil) ? client.JobContactLastName : ""
clientArrayData["JobContactPhone"] = (client.JobContactPhone != nil) ? client.JobContactPhone : ""
clientArrayData["JobContactMobile"] = (client.JobContactMobile != nil) ? client.JobContactMobile : ""
clientArrayData["JobContactFax"] = (client.JobContactFax != nil) ? client.JobContactFax : ""
clientArrayData["JobContactEmail"] = (client.JobContactEmail != nil) ? client.JobContactEmail : ""
clientArrayData["IsSameAsJobContact"] = "\(String(describing: client.IsSameAsJobContact))"
clientArrayData["BillingContactTitle"] = (client.BillingContactTitle != nil) ? client.BillingContactTitle : ""
clientArrayData["BillingContactFirstName"] = (client.BillingContactFirstName != nil) ? client.BillingContactFirstName : ""
clientArrayData["BillingContactLastName"] = (client.BillingContactLastName != nil) ? client.BillingContactLastName : ""
clientArrayData["BillingContactMobile"] = (client.BillingContactMobile != nil) ? client.BillingContactMobile : ""
clientArrayData["BillingContactPhone"] = (client.BillingContactMobile != nil) ? client.BillingContactPhone : ""
clientArrayData["BillingContactFax"] = (client.BillingContactFax != nil) ? client.BillingContactFax : ""
clientArrayData["BillingContactEmail"] = (client.BillingContactEmail != nil) ? client.BillingContactEmail : ""
clientArrayData["Memos"] = (client.Memos != nil) ? client.Memos : ""
clientArrayData["JobAddress"] = (client.JobAddress != nil) ? client.JobAddress : ""
clientArrayData["JobAddressLine2"] = (client.JobAddressLine2 != nil) ? client.JobAddressLine2 : ""
clientArrayData["JobCity"] = (client.JobCity != nil) ? client.JobCity : ""
clientArrayData["JobState"] = (client.JobState != nil) ? client.JobState : ""
clientArrayData["JobPostalCode"] = (client.JobPostalCode != nil) ? client.JobPostalCode : ""
clientArrayData["JobCountry"] = (client.JobCountry != nil) ? client.JobCountry : ""
clientArrayData["IsSameAsJobAddress"] = "\(String(describing: client.IsSameAsJobAddress))"
clientArrayData["BillingAddress"] = (client.BillingAddress != nil) ? client.BillingAddress : ""
clientArrayData["BillingAddressLine2"] = (client.BillingAddressLine2 != nil) ? client.BillingAddressLine2 : ""
clientArrayData["BillingCity"] = (client.BillingCity != nil) ? client.BillingCity : ""
clientArrayData["BillingState"] = (client.BillingState != nil) ? client.BillingState : ""
clientArrayData["BillingPostalCode"] = (client.BillingPostalCode != nil) ? client.BillingPostalCode : ""
clientArrayData["BillingCountry"] = (client.BillingCountry != nil) ? client.BillingCountry: ""
clientArrayData["ABN"] = (client.ABN != nil) ? client.ABN : ""
clientArrayData["DefaultSalesDiscount"] = (client.DefaultSalesDiscount != nil) ? client.DefaultSalesDiscount : ""
clientArrayData["BSBNumber"] = (client.BSBNumber != nil) ? client.BSBNumber : ""
clientArrayData["BankAccountNumber"] = (client.BankAccountNumber != nil) ? client.BankAccountNumber : ""
clientArrayData["BankAccountName"] = (client.BankAccountName != nil) ? client.BankAccountName : ""
clientArrayData["StatementText"] = (client.StatementText != nil) ? client.StatementText : ""
clientArrayData["PaymentMemos"] = (client.PaymentMemos != nil) ? client.PaymentMemos : ""
clientArrayData["DefaultSalesTaxCodeID"] = (client.DefaultSalesTaxCodeID != nil) ? client.DefaultSalesTaxCodeID : ""
clientArrayData["IsInactive"] = "false"
clientArrayData["CreateDate"] = (client.CreateDate != nil) ? client.CreateDate : ""
clientArrayData["HasExportedToQ6"] = "false"
// clientArrayData["NeedValidate"] = "false"
parameters["ImportClientViewList"] = [clientArrayData as AnyObject] as AnyObject
let request = NSMutableURLRequest(url: NSURL(string: UrlString)! as URL, cachePolicy: NSURLRequest.CachePolicy.reloadIgnoringLocalCacheData, timeoutInterval: 300)
let jsonString = TASQSampleCommonLibrary.convertDictionaryToJSONData(dicData: parameters)
print(jsonString)
request.httpBody = jsonString.data(using: String.Encoding.utf8, allowLossyConversion: true)
request.httpMethod = "POST"
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
do {
let config = URLSessionConfiguration.default
let session = URLSession(configuration: config)
let task = session.dataTask(with: request as URLRequest, completionHandler: {
(data, response, error) in
})
task.resume()
}
}