JiwaAPI

<back to all web services

BM_StageCustomValuesQuery

Requires Authentication
BM_StageCustomValuesQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
BM_Stages_RecIDquerystringNo
BM_Stages_RecIDStartsWithquerystringNo
BM_Stages_RecIDEndsWithquerystringNo
BM_Stages_RecIDContainsquerystringNo
BM_Stages_RecIDLikequerystringNo
BM_Stages_RecIDBetweenquerystring[]No
BM_Stages_RecIDInquerystring[]No
BM_StageCustomFields_RecIDquerystringNo
BM_StageCustomFields_RecIDStartsWithquerystringNo
BM_StageCustomFields_RecIDEndsWithquerystringNo
BM_StageCustomFields_RecIDContainsquerystringNo
BM_StageCustomFields_RecIDLikequerystringNo
BM_StageCustomFields_RecIDBetweenquerystring[]No
BM_StageCustomFields_RecIDInquerystring[]No
ContentsquerystringNo
ContentsStartsWithquerystringNo
ContentsEndsWithquerystringNo
ContentsContainsquerystringNo
ContentsLikequerystringNo
ContentsBetweenquerystring[]No
ContentsInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
BM_StageCustomValues Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
BM_Stages_RecIDformstringNo
BM_StageCustomFields_RecIDformstringNo
ContentsformstringNo
LastSavedDateTimeformDateTimeNo
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/BM_StageCustomValuesQuery 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"],"BM_Stages_RecID":"String","BM_Stages_RecIDStartsWith":"String","BM_Stages_RecIDEndsWith":"String","BM_Stages_RecIDContains":"String","BM_Stages_RecIDLike":"String","BM_Stages_RecIDBetween":["String"],"BM_Stages_RecIDIn":["String"],"BM_StageCustomFields_RecID":"String","BM_StageCustomFields_RecIDStartsWith":"String","BM_StageCustomFields_RecIDEndsWith":"String","BM_StageCustomFields_RecIDContains":"String","BM_StageCustomFields_RecIDLike":"String","BM_StageCustomFields_RecIDBetween":["String"],"BM_StageCustomFields_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":[{"RecID":"String","BM_Stages_RecID":"String","BM_StageCustomFields_RecID":"String","Contents":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}