API Reference

Create a order

post
https://staging.probitypeople.com.au/api/1//orders

Create a new order and return the new order details

Path Params
int32
required

Organisation ID

Body Params
string
string
required
string
string
required
string
string
required
string
required
string
enum

1=Male, 2=Female, 3=Others

Allowed:
date
string
int32

Please check your account settings page to see the location ID.

int32

Please check your account settings page to see the PO Number ID.

string
enum

Whether to create a new candidate profile for this order or use existing candidate profile (if exist). Email address is used to match candidate profile.

Allowed:
checks
array
required

array of object with check id and quantity. Eg: [{"id": 1, "quantity": 1 }]

checks*
json

Please refer to the ProbityPeople-provided document to view check-specific metadata

Responses

Updated 3 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago