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 | |
DB_DebtorSystemTemplates_RecID | query | string | No | |
DB_DebtorSystemTemplates_RecIDStartsWith | query | string | No | |
DB_DebtorSystemTemplates_RecIDEndsWith | query | string | No | |
DB_DebtorSystemTemplates_RecIDContains | query | string | No | |
DB_DebtorSystemTemplates_RecIDLike | query | string | No | |
DB_DebtorSystemTemplates_RecIDBetween | query | string[] | No | |
DB_DebtorSystemTemplates_RecIDIn | query | string[] | 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 | Nullable<DateTime>[] | No | |
LastSavedDateTimeIn | query | Nullable<DateTime>[] | No | |
Name | query | string | No | |
NameStartsWith | query | string | No | |
NameEndsWith | query | string | No | |
NameContains | query | string | No | |
NameLike | query | string | No | |
NameBetween | query | string[] | No | |
NameIn | query | string[] | No | |
FieldType | query | short? | No | |
FieldTypeGreaterThanOrEqualTo | query | short? | No | |
FieldTypeGreaterThan | query | short? | No | |
FieldTypeLessThan | query | short? | No | |
FieldTypeLessThanOrEqualTo | query | short? | No | |
FieldTypeNotEqualTo | query | short? | No | |
FieldTypeBetween | query | short[] | No | |
FieldTypeIn | query | short[] | No | |
ComboText | query | string | No | |
ComboTextStartsWith | query | string | No | |
ComboTextEndsWith | query | string | No | |
ComboTextContains | query | string | No | |
ComboTextLike | query | string | No | |
ComboTextBetween | query | string[] | No | |
ComboTextIn | query | string[] | No | |
DefaultValue | query | string | No | |
DefaultValueStartsWith | query | string | No | |
DefaultValueEndsWith | query | string | No | |
DefaultValueContains | query | string | No | |
DefaultValueLike | query | string | No | |
DefaultValueBetween | query | string[] | No | |
DefaultValueIn | query | string[] | No | |
ItemNo | query | int? | No | |
ItemNoGreaterThanOrEqualTo | query | int? | No | |
ItemNoGreaterThan | query | int? | No | |
ItemNoLessThan | query | int? | No | |
ItemNoLessThanOrEqualTo | query | int? | No | |
ItemNoNotEqualTo | query | int? | No | |
ItemNoBetween | query | int[] | No | |
ItemNoIn | query | int[] | No | |
RowHash | query | byte[] | 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 | |
DB_DebtorSystemTemplates_RecID | form | string | No | |
LastSavedDateTime | form | DateTime? | No | |
Name | form | string | No | |
FieldType | form | short | No | |
ComboText | form | string | No | |
DefaultValue | form | string | No | |
ItemNo | form | int | No | |
RowHash | form | byte[] | 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/DB_DebtorSystemTemplateFieldsQuery 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"],"DB_DebtorSystemTemplates_RecID":"String","DB_DebtorSystemTemplates_RecIDStartsWith":"String","DB_DebtorSystemTemplates_RecIDEndsWith":"String","DB_DebtorSystemTemplates_RecIDContains":"String","DB_DebtorSystemTemplates_RecIDLike":"String","DB_DebtorSystemTemplates_RecIDBetween":["String"],"DB_DebtorSystemTemplates_RecIDIn":["String"],"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"],"Name":"String","NameStartsWith":"String","NameEndsWith":"String","NameContains":"String","NameLike":"String","NameBetween":["String"],"NameIn":["String"],"FieldType":0,"FieldTypeGreaterThanOrEqualTo":0,"FieldTypeGreaterThan":0,"FieldTypeLessThan":0,"FieldTypeLessThanOrEqualTo":0,"FieldTypeNotEqualTo":0,"FieldTypeBetween":[0],"FieldTypeIn":[0],"ComboText":"String","ComboTextStartsWith":"String","ComboTextEndsWith":"String","ComboTextContains":"String","ComboTextLike":"String","ComboTextBetween":["String"],"ComboTextIn":["String"],"DefaultValue":"String","DefaultValueStartsWith":"String","DefaultValueEndsWith":"String","DefaultValueContains":"String","DefaultValueLike":"String","DefaultValueBetween":["String"],"DefaultValueIn":["String"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"RowHash":"AA==","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","DB_DebtorSystemTemplates_RecID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","Name":"String","ComboText":"String","DefaultValue":"String","RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}