Get Job Order

Get Job Order

Purpose

To get the Job/Location of your Organization.

Job API accept post request with filter conditions. Response include filter jobs array with matching conditions.

API return JSON array of jobs.

Request URL

https://live.membroz.com/api/jobs/filter

Request Method

POST
Note
  • Send authkey in https header
  • You must use only Field API names in the input. You can obtain the field API names from Fields metadata API
  • Enterprise customer can replace domain name with their hosting Url. for example https://app.xyz.com/api/jobs
  • API will return matching records in array or error message.

Request JSON

Attribute Data Type Mandatory Description
search Array yes Add search fields to filter out return data.
Example: { "search":[{ "searchfield": "status", "searchvalue": "active", "criteria": "eq", "datattype": "text" }]}
Only status = "active" records will return
select Array Add select fields to restrict return data schema.
Example: Example: { "fieldname": "branchname", "value": 1 }
Only branchname will return
sort object Sort return array based on sort input
Example: { "branchname" : 1}
limit number limit return array size
Example: limit: 10
only 10 records will return in the array

Sample Request

curl --location --request POST 'https://live.membroz.com/api/jobs/filter' \
--header 'authkey: XXXXXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{ 
    "search": [
        { "searchfield": "status", "searchvalue": "active", "criteria": "eq", "datatype": "text" }
    ]
}'
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{ \r\n    \"search\": [\r\n        { \"searchfield\": \"status\", \"searchvalue\": \"active\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}");
Request request = new Request.Builder()
  .url("https://live.membroz.com/api/jobs/filter")
  .method("POST", body)
  .addHeader("authkey", "XXXXXXXXXX ")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();
 "https://live.membroz.com/api/jobs/filter",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>"{ \r\n    \"search\": [\r\n        { \"searchfield\": \"status\", \"searchvalue\": \"active\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}",
  CURLOPT_HTTPHEADER => array(
    "authkey: XXXXXXXXXX ",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import requests

url = "https://live.membroz.com/api/jobs/filter"

payload = "{ \r\n    \"search\": [\r\n        { \"searchfield\": \"status\", \"searchvalue\": \"active\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}"
headers = {
  'authkey': 'XXXXXXXXXX' ,
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))

require "uri"
require "net/http"

url = URI("https://live.membroz.com/api/jobs/filter")

https = Net::HTTP.new(url.host, url.port);
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authkey"] = "XXXXXXXXXX "
request["Content-Type"] = "application/json"
request.body = "{ \r\n    \"search\": [\r\n        { \"searchfield\": \"status\", \"searchvalue\": \"active\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}"

response = https.request(request)
puts response.read_body

var client = new RestClient("https://live.membroz.com/api/jobs/filter");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("authkey", "XXXXXXXXXX ");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{ \r\n    \"search\": [\r\n        { \"searchfield\": \"status\", \"searchvalue\": \"active\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}",  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Possible Errors

HTTP Status Error Code Message Reason
permission denied 403 You do not have permission

Sample Response

  {
        "_id": "5f86f0c00ce3361fcc69ec95",
        "status": "active",
        "prefix": "JO",
        "jobnumber": 2,
        "date": "2020-10-14T12:34:31.628Z",
        "notes": "Notes TESTIKNMG",
        "customerid": "5eb4e61a2b81e31504110b35",
        "onModel": "Member",
        "dispositionid":"5f7e9a9b3271df1d8b56c931",
        "dispositiondataid": "5f86f0bf0ce3361fcc69ec93",
        "tasks":  "5f86f0c00ce3361fcc69ec96",
        "items":  "5f86f0c00ce3361fcc69ec97",
        "totalamount": 60,
        "taxamount": 0,
        "branchid": "5eb4e4164df5b8f44508cbcc",
        "createdAt": "2020-10-14T12:36:16.354Z",
        "updatedAt": "2020-10-14T12:36:16.354Z",
        "updatedby": "5eb4e4164df5b8f44508cbce",
        "addedby": {
            "_id": "5eb4e4164df5b8f44508cbce",
            "isfirstlogin": false,
            "status": "active",
            "username": "membrozcarworkshop@gmail.com",
            "password": "$2a$10$vLkyHcfaCIBXp3B1o4n.Ze68HXVLR1/7INOXDhz7VhGkvvWflvB7m",
            "role": "5dd7e2b080199f0aecd400b5",
            "anroiddevices": [],
            "iosdevices": [],
            "designationid": "5c9a0e1112b3f913dc5ab3ba",
            "branchid": "5eb4e4164df5b8f44508cbcc",
            "property": {
                "fullname": "Membroz Service",
                "mobile_number": "8758363925",
                "email": "membrozservice@gmail.com",
                "country": "India",
                "membrozid": "5eb4e4164df5b8f44508cbcc",
                "isadmin": false
            },
            "createdAt": "2020-05-08T04:46:14.813Z",
            "updatedAt": "2020-05-08T04:47:00.243Z",
            "fullname": "Membroz Service ",
            "namenumber": "Membroz Service  | 8758363925"
        },
        "docnumber": "JO-2"
    },