Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | query | string | No | |
RecIDStartsWith | query | string | No | |
RecIDEndsWith | query | string | No | |
RecIDContains | query | string | No | |
RecIDLike | query | string | No | |
RecIDBetween | query | string[] | No | |
RecIDIn | query | string[] | No | |
TaskNo | query | int? | No | |
TaskNoGreaterThanOrEqualTo | query | int? | No | |
TaskNoGreaterThan | query | int? | No | |
TaskNoLessThan | query | int? | No | |
TaskNoLessThanOrEqualTo | query | int? | No | |
TaskNoNotEqualTo | query | int? | No | |
TaskNoBetween | query | int[] | No | |
TaskNoIn | query | int[] | No | |
SM_Jobs_RecID | query | string | No | |
SM_Jobs_RecIDStartsWith | query | string | No | |
SM_Jobs_RecIDEndsWith | query | string | No | |
SM_Jobs_RecIDContains | query | string | No | |
SM_Jobs_RecIDLike | query | string | No | |
SM_Jobs_RecIDBetween | query | string[] | No | |
SM_Jobs_RecIDIn | query | string[] | No | |
HR_Departments_RecID | query | string | No | |
HR_Departments_RecIDStartsWith | query | string | No | |
HR_Departments_RecIDEndsWith | query | string | No | |
HR_Departments_RecIDContains | query | string | No | |
HR_Departments_RecIDLike | query | string | No | |
HR_Departments_RecIDBetween | query | string[] | No | |
HR_Departments_RecIDIn | query | string[] | No | |
HR_DepartmentCategories_RecID | query | string | No | |
HR_DepartmentCategories_RecIDStartsWith | query | string | No | |
HR_DepartmentCategories_RecIDEndsWith | query | string | No | |
HR_DepartmentCategories_RecIDContains | query | string | No | |
HR_DepartmentCategories_RecIDLike | query | string | No | |
HR_DepartmentCategories_RecIDBetween | query | string[] | No | |
HR_DepartmentCategories_RecIDIn | query | string[] | No | |
SM_Priorities_RecID | query | string | No | |
SM_Priorities_RecIDStartsWith | query | string | No | |
SM_Priorities_RecIDEndsWith | query | string | No | |
SM_Priorities_RecIDContains | query | string | No | |
SM_Priorities_RecIDLike | query | string | No | |
SM_Priorities_RecIDBetween | query | string[] | No | |
SM_Priorities_RecIDIn | query | string[] | No | |
SM_Statuses_RecID | query | string | No | |
SM_Statuses_RecIDStartsWith | query | string | No | |
SM_Statuses_RecIDEndsWith | query | string | No | |
SM_Statuses_RecIDContains | query | string | No | |
SM_Statuses_RecIDLike | query | string | No | |
SM_Statuses_RecIDBetween | query | string[] | No | |
SM_Statuses_RecIDIn | query | string[] | No | |
AssignedTo_HR_Staff_RecID | query | string | No | |
AssignedTo_HR_Staff_RecIDStartsWith | query | string | No | |
AssignedTo_HR_Staff_RecIDEndsWith | query | string | No | |
AssignedTo_HR_Staff_RecIDContains | query | string | No | |
AssignedTo_HR_Staff_RecIDLike | query | string | No | |
AssignedTo_HR_Staff_RecIDBetween | query | string[] | No | |
AssignedTo_HR_Staff_RecIDIn | query | string[] | No | |
Description | query | string | No | |
DescriptionStartsWith | query | string | No | |
DescriptionEndsWith | query | string | No | |
DescriptionContains | query | string | No | |
DescriptionLike | query | string | No | |
DescriptionBetween | query | string[] | No | |
DescriptionIn | query | string[] | No | |
Note | query | string | No | |
NoteStartsWith | query | string | No | |
NoteEndsWith | query | string | No | |
NoteContains | query | string | No | |
NoteLike | query | string | No | |
NoteBetween | query | string[] | No | |
NoteIn | query | string[] | No | |
DateLogged | query | DateTime? | No | |
DateLoggedGreaterThanOrEqualTo | query | DateTime? | No | |
DateLoggedGreaterThan | query | DateTime? | No | |
DateLoggedLessThan | query | DateTime? | No | |
DateLoggedLessThanOrEqualTo | query | DateTime? | No | |
DateLoggedNotEqualTo | query | DateTime? | No | |
DateLoggedBetween | query | DateTime[] | No | |
DateLoggedIn | query | DateTime[] | No | |
LoggedBy_HR_Staff_RecID | query | string | No | |
LoggedBy_HR_Staff_RecIDStartsWith | query | string | No | |
LoggedBy_HR_Staff_RecIDEndsWith | query | string | No | |
LoggedBy_HR_Staff_RecIDContains | query | string | No | |
LoggedBy_HR_Staff_RecIDLike | query | string | No | |
LoggedBy_HR_Staff_RecIDBetween | query | string[] | No | |
LoggedBy_HR_Staff_RecIDIn | query | string[] | No | |
HasDeadline | query | bool? | No | |
Deadline | query | DateTime? | No | |
DeadlineGreaterThanOrEqualTo | query | DateTime? | No | |
DeadlineGreaterThan | query | DateTime? | No | |
DeadlineLessThan | query | DateTime? | No | |
DeadlineLessThanOrEqualTo | query | DateTime? | No | |
DeadlineNotEqualTo | query | DateTime? | No | |
DeadlineBetween | query | Nullable<DateTime>[] | No | |
DeadlineIn | query | Nullable<DateTime>[] | No | |
CompletionDate | query | DateTime? | No | |
CompletionDateGreaterThanOrEqualTo | query | DateTime? | No | |
CompletionDateGreaterThan | query | DateTime? | No | |
CompletionDateLessThan | query | DateTime? | No | |
CompletionDateLessThanOrEqualTo | query | DateTime? | No | |
CompletionDateNotEqualTo | query | DateTime? | No | |
CompletionDateBetween | query | Nullable<DateTime>[] | No | |
CompletionDateIn | query | Nullable<DateTime>[] | No | |
LastSavedDateTime | query | DateTime? | No | |
LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeGreaterThan | query | DateTime? | No | |
LastSavedDateTimeLessThan | query | DateTime? | No | |
LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
LastSavedDateTimeBetween | query | DateTime[] | No | |
LastSavedDateTimeIn | query | DateTime[] | No | |
LastSaved_HR_Staff_RecID | query | string | No | |
LastSaved_HR_Staff_RecIDStartsWith | query | string | No | |
LastSaved_HR_Staff_RecIDEndsWith | query | string | No | |
LastSaved_HR_Staff_RecIDContains | query | string | No | |
LastSaved_HR_Staff_RecIDLike | query | string | No | |
LastSaved_HR_Staff_RecIDBetween | query | string[] | No | |
LastSaved_HR_Staff_RecIDIn | query | string[] | No | |
SM_PrepaidLabourPacks_RecID | query | string | No | |
SM_PrepaidLabourPacks_RecIDStartsWith | query | string | No | |
SM_PrepaidLabourPacks_RecIDEndsWith | query | string | No | |
SM_PrepaidLabourPacks_RecIDContains | query | string | No | |
SM_PrepaidLabourPacks_RecIDLike | query | string | No | |
SM_PrepaidLabourPacks_RecIDBetween | query | string[] | No | |
SM_PrepaidLabourPacks_RecIDIn | query | string[] | No | |
DB_DeliveryAddress_RecID | query | string | No | |
DB_DeliveryAddress_RecIDStartsWith | query | string | No | |
DB_DeliveryAddress_RecIDEndsWith | query | string | No | |
DB_DeliveryAddress_RecIDContains | query | string | No | |
DB_DeliveryAddress_RecIDLike | query | string | No | |
DB_DeliveryAddress_RecIDBetween | query | string[] | No | |
DB_DeliveryAddress_RecIDIn | query | string[] | No | |
DB_DebtorSystems_RecID | query | string | No | |
DB_DebtorSystems_RecIDStartsWith | query | string | No | |
DB_DebtorSystems_RecIDEndsWith | query | string | No | |
DB_DebtorSystems_RecIDContains | query | string | No | |
DB_DebtorSystems_RecIDLike | query | string | No | |
DB_DebtorSystems_RecIDBetween | query | string[] | No | |
DB_DebtorSystems_RecIDIn | query | string[] | No | |
IsRetired | query | bool? | No | |
RowHash | query | byte[] | No | |
BillingDebtor_DB_Main_RecID | query | string | No | |
BillingDebtor_DB_Main_RecIDStartsWith | query | string | No | |
BillingDebtor_DB_Main_RecIDEndsWith | query | string | No | |
BillingDebtor_DB_Main_RecIDContains | query | string | No | |
BillingDebtor_DB_Main_RecIDLike | query | string | No | |
BillingDebtor_DB_Main_RecIDBetween | query | string[] | No | |
BillingDebtor_DB_Main_RecIDIn | query | string[] | No | |
BillingDebtor_DB_DeliveryAddress_RecID | query | string | No | |
BillingDebtor_DB_DeliveryAddress_RecIDStartsWith | query | string | No | |
BillingDebtor_DB_DeliveryAddress_RecIDEndsWith | query | string | No | |
BillingDebtor_DB_DeliveryAddress_RecIDContains | query | string | No | |
BillingDebtor_DB_DeliveryAddress_RecIDLike | query | string | No | |
BillingDebtor_DB_DeliveryAddress_RecIDBetween | query | string[] | No | |
BillingDebtor_DB_DeliveryAddress_RecIDIn | query | string[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | form | string | No | |
TaskNo | form | int | No | |
SM_Jobs_RecID | form | string | No | |
HR_Departments_RecID | form | string | No | |
HR_DepartmentCategories_RecID | form | string | No | |
SM_Priorities_RecID | form | string | No | |
SM_Statuses_RecID | form | string | No | |
AssignedTo_HR_Staff_RecID | form | string | No | |
Description | form | string | No | |
Note | form | string | No | |
DateLogged | form | DateTime | No | |
LoggedBy_HR_Staff_RecID | form | string | No | |
HasDeadline | form | bool? | No | |
Deadline | form | DateTime? | No | |
CompletionDate | form | DateTime? | No | |
LastSavedDateTime | form | DateTime | No | |
LastSaved_HR_Staff_RecID | form | string | No | |
SM_PrepaidLabourPacks_RecID | form | string | No | |
DB_DeliveryAddress_RecID | form | string | No | |
DB_DebtorSystems_RecID | form | string | No | |
IsRetired | form | bool? | No | |
RowHash | form | byte[] | No | |
BillingDebtor_DB_Main_RecID | form | string | No | |
BillingDebtor_DB_DeliveryAddress_RecID | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/SM_TasksQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"TaskNo":0,"TaskNoGreaterThanOrEqualTo":0,"TaskNoGreaterThan":0,"TaskNoLessThan":0,"TaskNoLessThanOrEqualTo":0,"TaskNoNotEqualTo":0,"TaskNoBetween":[0],"TaskNoIn":[0],"SM_Jobs_RecID":"String","SM_Jobs_RecIDStartsWith":"String","SM_Jobs_RecIDEndsWith":"String","SM_Jobs_RecIDContains":"String","SM_Jobs_RecIDLike":"String","SM_Jobs_RecIDBetween":["String"],"SM_Jobs_RecIDIn":["String"],"HR_Departments_RecID":"String","HR_Departments_RecIDStartsWith":"String","HR_Departments_RecIDEndsWith":"String","HR_Departments_RecIDContains":"String","HR_Departments_RecIDLike":"String","HR_Departments_RecIDBetween":["String"],"HR_Departments_RecIDIn":["String"],"HR_DepartmentCategories_RecID":"String","HR_DepartmentCategories_RecIDStartsWith":"String","HR_DepartmentCategories_RecIDEndsWith":"String","HR_DepartmentCategories_RecIDContains":"String","HR_DepartmentCategories_RecIDLike":"String","HR_DepartmentCategories_RecIDBetween":["String"],"HR_DepartmentCategories_RecIDIn":["String"],"SM_Priorities_RecID":"String","SM_Priorities_RecIDStartsWith":"String","SM_Priorities_RecIDEndsWith":"String","SM_Priorities_RecIDContains":"String","SM_Priorities_RecIDLike":"String","SM_Priorities_RecIDBetween":["String"],"SM_Priorities_RecIDIn":["String"],"SM_Statuses_RecID":"String","SM_Statuses_RecIDStartsWith":"String","SM_Statuses_RecIDEndsWith":"String","SM_Statuses_RecIDContains":"String","SM_Statuses_RecIDLike":"String","SM_Statuses_RecIDBetween":["String"],"SM_Statuses_RecIDIn":["String"],"AssignedTo_HR_Staff_RecID":"String","AssignedTo_HR_Staff_RecIDStartsWith":"String","AssignedTo_HR_Staff_RecIDEndsWith":"String","AssignedTo_HR_Staff_RecIDContains":"String","AssignedTo_HR_Staff_RecIDLike":"String","AssignedTo_HR_Staff_RecIDBetween":["String"],"AssignedTo_HR_Staff_RecIDIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"Note":"String","NoteStartsWith":"String","NoteEndsWith":"String","NoteContains":"String","NoteLike":"String","NoteBetween":["String"],"NoteIn":["String"],"DateLogged":"0001-01-01T00:00:00.0000000","DateLoggedGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateLoggedGreaterThan":"0001-01-01T00:00:00.0000000","DateLoggedLessThan":"0001-01-01T00:00:00.0000000","DateLoggedLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateLoggedNotEqualTo":"0001-01-01T00:00:00.0000000","DateLoggedBetween":["0001-01-01T00:00:00.0000000"],"DateLoggedIn":["0001-01-01T00:00:00.0000000"],"LoggedBy_HR_Staff_RecID":"String","LoggedBy_HR_Staff_RecIDStartsWith":"String","LoggedBy_HR_Staff_RecIDEndsWith":"String","LoggedBy_HR_Staff_RecIDContains":"String","LoggedBy_HR_Staff_RecIDLike":"String","LoggedBy_HR_Staff_RecIDBetween":["String"],"LoggedBy_HR_Staff_RecIDIn":["String"],"HasDeadline":false,"Deadline":"0001-01-01T00:00:00.0000000","DeadlineGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DeadlineGreaterThan":"0001-01-01T00:00:00.0000000","DeadlineLessThan":"0001-01-01T00:00:00.0000000","DeadlineLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DeadlineNotEqualTo":"0001-01-01T00:00:00.0000000","DeadlineBetween":["0001-01-01T00:00:00.0000000"],"DeadlineIn":["0001-01-01T00:00:00.0000000"],"CompletionDate":"0001-01-01T00:00:00.0000000","CompletionDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","CompletionDateGreaterThan":"0001-01-01T00:00:00.0000000","CompletionDateLessThan":"0001-01-01T00:00:00.0000000","CompletionDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","CompletionDateNotEqualTo":"0001-01-01T00:00:00.0000000","CompletionDateBetween":["0001-01-01T00:00:00.0000000"],"CompletionDateIn":["0001-01-01T00:00:00.0000000"],"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"LastSavedDateTimeIn":["0001-01-01T00:00:00.0000000"],"LastSaved_HR_Staff_RecID":"String","LastSaved_HR_Staff_RecIDStartsWith":"String","LastSaved_HR_Staff_RecIDEndsWith":"String","LastSaved_HR_Staff_RecIDContains":"String","LastSaved_HR_Staff_RecIDLike":"String","LastSaved_HR_Staff_RecIDBetween":["String"],"LastSaved_HR_Staff_RecIDIn":["String"],"SM_PrepaidLabourPacks_RecID":"String","SM_PrepaidLabourPacks_RecIDStartsWith":"String","SM_PrepaidLabourPacks_RecIDEndsWith":"String","SM_PrepaidLabourPacks_RecIDContains":"String","SM_PrepaidLabourPacks_RecIDLike":"String","SM_PrepaidLabourPacks_RecIDBetween":["String"],"SM_PrepaidLabourPacks_RecIDIn":["String"],"DB_DeliveryAddress_RecID":"String","DB_DeliveryAddress_RecIDStartsWith":"String","DB_DeliveryAddress_RecIDEndsWith":"String","DB_DeliveryAddress_RecIDContains":"String","DB_DeliveryAddress_RecIDLike":"String","DB_DeliveryAddress_RecIDBetween":["String"],"DB_DeliveryAddress_RecIDIn":["String"],"DB_DebtorSystems_RecID":"String","DB_DebtorSystems_RecIDStartsWith":"String","DB_DebtorSystems_RecIDEndsWith":"String","DB_DebtorSystems_RecIDContains":"String","DB_DebtorSystems_RecIDLike":"String","DB_DebtorSystems_RecIDBetween":["String"],"DB_DebtorSystems_RecIDIn":["String"],"IsRetired":false,"RowHash":"AA==","BillingDebtor_DB_Main_RecID":"String","BillingDebtor_DB_Main_RecIDStartsWith":"String","BillingDebtor_DB_Main_RecIDEndsWith":"String","BillingDebtor_DB_Main_RecIDContains":"String","BillingDebtor_DB_Main_RecIDLike":"String","BillingDebtor_DB_Main_RecIDBetween":["String"],"BillingDebtor_DB_Main_RecIDIn":["String"],"BillingDebtor_DB_DeliveryAddress_RecID":"String","BillingDebtor_DB_DeliveryAddress_RecIDStartsWith":"String","BillingDebtor_DB_DeliveryAddress_RecIDEndsWith":"String","BillingDebtor_DB_DeliveryAddress_RecIDContains":"String","BillingDebtor_DB_DeliveryAddress_RecIDLike":"String","BillingDebtor_DB_DeliveryAddress_RecIDBetween":["String"],"BillingDebtor_DB_DeliveryAddress_RecIDIn":["String"],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"Results":[{"RecID":"String","SM_Jobs_RecID":"String","HR_Departments_RecID":"String","HR_DepartmentCategories_RecID":"String","SM_Priorities_RecID":"String","SM_Statuses_RecID":"String","AssignedTo_HR_Staff_RecID":"String","Description":"String","Note":"String","LoggedBy_HR_Staff_RecID":"String","HasDeadline":false,"Deadline":"0001-01-01T00:00:00.0000000","CompletionDate":"0001-01-01T00:00:00.0000000","LastSaved_HR_Staff_RecID":"String","SM_PrepaidLabourPacks_RecID":"String","DB_DeliveryAddress_RecID":"String","DB_DebtorSystems_RecID":"String","IsRetired":false,"RowHash":"AA==","BillingDebtor_DB_Main_RecID":"String","BillingDebtor_DB_DeliveryAddress_RecID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}