1. Home
  2. Docs
  3. API Overview
  4. Documents – Client
  5. Create Client

Create Client

Create the client for TASQ.

URL:

 https://jobapi.tasq.com.au/api/Job/CreateClient

Supports:

POST.

Attribute Details:

CompanyValidateInfo (object) must
LoginName (string)
ClientIP (string)
Password (string)
MobileDeviceToken (string)
WebApiTOKEN (Guid)
Client (object)  
ClientID (Guid) optional
ClientName (string) (200) must
JobContactTitle (string) (50) optional
Mr/Ms/Mrs/Miss
JobContactFirstName (string) (200) optional
JobContactLastName (string) (200) optional
JobContactPhone (string) (50) optional
JobContactMobile (string) (50) optional
JobContactFax (string) (50) optional
JobContactEmail (string) (100) optional
IsSameAsJobContact (bool)
BillingContactTitle (string) (50) optional
Mr/Ms/Mrs/Miss
BillingContactFirstName (string) (200) optional
BillingContactLastName (string) (200) optional
BillingContactPhone (string) (50) optional
BillingContactMobile (string) (50) optional
BillingContactFax (string) (50) optional
BillingContactEmail (string) (100) optional
Memos (string) optional
JobAddress (string) (200) optional
JobAddressLine2 (string) (200) optional
JobCity (string) (100) optional
JobState (string) (50) optional
ACT/NSW/NT/TAS/QLD/SA/VIC/WA
JobPostalCode (string) (50) optional
JobCountry (string) (50) must
IsSameAsJobAddress (bool)
BillingAddress (string) (200) optional
BillingAddressLine2 (string) (200) optional
BillingCity (string) (100) optional
BillingState (string) (50) optional
ACT/NSW/NT/TAS/QLD/SA/VIC/WA
BillingPostalCode (string) (50) optional
BillingCountry (string) (50) must
ABN (string) (20) optional
DefaultSalesDiscount (decimal) (5,2) optional
BSBNumber (string) (7) optional
BankAccountNumber (string) (30) optional
BankAccountName (string) (100) optional
StatementText (string) (30) optional
PaymentMemos (string) optional
DefaultSalesTaxCodeID (Guid) optional
IsInactive (bool)
CreateDate (date) optional
HasExportedToQ6 (bool)

Example JSON POST data:

{

"CompanyValidateInfo": {
"ClientIP": null,
"LoginName": "testapi@tasq.com.au",
"MobileDeviceToken": null,
"Password": "test123.",
"WebApiTOKEN": "b3b777b0-c7af-458d-be64-b3d6d760177f"
},

"Client": {

"ClientID":                null,

"ClientName":              "ZiliangCai",

"JobContactTitle":         "Mr",

"JobContactFirstName":     "ziliang",

"JobContactLastName":      "cai",

"JobContactPhone":         "15689466954",

"JobContactMobile":        "0385943163",

"JobContactFax":           "0358161864",

"JobContactEmail":         "ziliangcai@uniware.com.au",

"IsSameAsJobContact":      false,

"BillingContactTitle":     "Mr",

"BillingContactFirstName": "ziliang",

"BillingContactLastName": "cai",

"BillingContactPhone":     "15846531506",

"BillingContactMobile":    "0369583214",

"BillingContactFax":       "0369846159",

"BillingContactEmail":     "ziliangcai@uniware.com.au",

"Memos":                   "Memo Text",

"JobAddress":              "HuBei",

"JobAddressLine2":         "HePingDaDao",

"JobCity":                 "WuHan",

"JobState":                "NT",

"JobPostalCode":           "4300000",

"JobCountry":              "Australia",

"IsSameAsJobAddress":      true,

"BillingAddress":          "HuBei",

"BillingAddressLine2":     "HePingDaDao",

"BillingCity":             "WuHan",

"BillingState":            "NT",

"BillingPostalCode":       "4300000",

"BillingCountry":          "Australia",

"ABN":                      "53004085616",

"DefaultSalesDiscount":    20.0,

"BSBNumber":               "454211",

"BankAccountNumber":       "Bank156",

"BankAccountName":         "Ziliang",

"StatementText":           "Statement Text",

"PaymentMemos":            "Payment Memo Text",

"DefaultSalesTaxCodeID": "143aa782-6c6b-44ee-8d26-fd2a70b7f51d",

"IsInactive":              false,

"CreateDate":              null,

"HasExportedToQ6":         null

}

}





Return Value:

{

ActionCode:   (string)                 "Create",

ErrorMessage: (string),                "",

IsSuccessed: (string)                 "YES",

RetrunData:   (object)                 "53c9da55-ab9b-4c61-bfc5-9ecc12190d44"

}

C# Sample Code:

public static string CreateClient (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 CreateClient () {

        $.ajax({

            type: "Post",

            url: "https://jobapi.tasq.com.au/api/Item/CreateClient",

            data: {

               …

            },

            dataType: "json",

            success: function (data) {

                console.dir(data)

            },

            error: function (e) {

                console.dir(e)

            }

        });

    }

Java Sample Code:

private static void CreateClient(String json){
    try {
        URL url = new URL("https://jobapi.tasq.com.au/api/Job/CreateClient");
        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

Swift Sample Code:
func CreateClient ()

{

    let client: Client = Client()

    let UrlString = TASQSampleCommonLibrary.TASQApiUrl + "Job/CreateClient"

    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["Client"]  = clientArrayData 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()

    }

}

How can we help?