JiwaAPI

<back to all web services

PI_CustomSettingValuesQuery

Requires Authentication
PI_CustomSettingValuesQuery Parameters:
NameParameterData TypeRequiredDescription
SettingValueIDquerystringNo
SettingValueIDStartsWithquerystringNo
SettingValueIDEndsWithquerystringNo
SettingValueIDContainsquerystringNo
SettingValueIDLikequerystringNo
SettingValueIDBetweenquerystring[]No
SettingValueIDInquerystring[]No
SettingIDquerystringNo
SettingIDStartsWithquerystringNo
SettingIDEndsWithquerystringNo
SettingIDContainsquerystringNo
SettingIDLikequerystringNo
SettingIDBetweenquerystring[]No
SettingIDInquerystring[]No
PI_Main_RecIDquerystringNo
PI_Main_RecIDStartsWithquerystringNo
PI_Main_RecIDEndsWithquerystringNo
PI_Main_RecIDContainsquerystringNo
PI_Main_RecIDLikequerystringNo
PI_Main_RecIDBetweenquerystring[]No
PI_Main_RecIDInquerystring[]No
ContentsquerystringNo
ContentsStartsWithquerystringNo
ContentsEndsWithquerystringNo
ContentsContainsquerystringNo
ContentsLikequerystringNo
ContentsBetweenquerystring[]No
ContentsInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
PI_CustomSettingValues Parameters:
NameParameterData TypeRequiredDescription
SettingValueIDformstringNo
SettingIDformstringNo
PI_Main_RecIDformstringNo
ContentsformstringNo
LastSavedDateTimeformDateTime?No
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/PI_CustomSettingValuesQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"SettingValueID":"String","SettingValueIDStartsWith":"String","SettingValueIDEndsWith":"String","SettingValueIDContains":"String","SettingValueIDLike":"String","SettingValueIDBetween":["String"],"SettingValueIDIn":["String"],"SettingID":"String","SettingIDStartsWith":"String","SettingIDEndsWith":"String","SettingIDContains":"String","SettingIDLike":"String","SettingIDBetween":["String"],"SettingIDIn":["String"],"PI_Main_RecID":"String","PI_Main_RecIDStartsWith":"String","PI_Main_RecIDEndsWith":"String","PI_Main_RecIDContains":"String","PI_Main_RecIDLike":"String","PI_Main_RecIDBetween":["String"],"PI_Main_RecIDIn":["String"],"Contents":"String","ContentsStartsWith":"String","ContentsEndsWith":"String","ContentsContains":"String","ContentsLike":"String","ContentsBetween":["String"],"ContentsIn":["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"],"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":[{"SettingValueID":"String","SettingID":"String","PI_Main_RecID":"String","Contents":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}