JiwaAPI

<back to all web services

CN_GroupLinkQuery

Requires Authentication
CN_GroupLinkQuery Parameters:
NameParameterData TypeRequiredDescription
LinkIDquerystringNo
LinkIDStartsWithquerystringNo
LinkIDEndsWithquerystringNo
LinkIDContainsquerystringNo
LinkIDLikequerystringNo
LinkIDBetweenquerystring[]No
LinkIDInquerystring[]No
GroupIDquerystringNo
GroupIDStartsWithquerystringNo
GroupIDEndsWithquerystringNo
GroupIDContainsquerystringNo
GroupIDLikequerystringNo
GroupIDBetweenquerystring[]No
GroupIDInquerystring[]No
ProspectIDquerystringNo
ProspectIDStartsWithquerystringNo
ProspectIDEndsWithquerystringNo
ProspectIDContainsquerystringNo
ProspectIDLikequerystringNo
ProspectIDBetweenquerystring[]No
ProspectIDInquerystring[]No
StaffIDquerystringNo
StaffIDStartsWithquerystringNo
StaffIDEndsWithquerystringNo
StaffIDContainsquerystringNo
StaffIDLikequerystringNo
StaffIDBetweenquerystring[]No
StaffIDInquerystring[]No
DefaultItemquerybool?No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryNullable<Int32>[]No
ItemNoInqueryNullable<Int32>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CN_GroupLink Parameters:
NameParameterData TypeRequiredDescription
LinkIDformstringNo
GroupIDformstringNo
ProspectIDformstringNo
StaffIDformstringNo
DefaultItemformboolNo
LastSavedDateTimeformDateTimeNo
ItemNoformint?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/CN_GroupLinkQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"LinkID":"String","LinkIDStartsWith":"String","LinkIDEndsWith":"String","LinkIDContains":"String","LinkIDLike":"String","LinkIDBetween":["String"],"LinkIDIn":["String"],"GroupID":"String","GroupIDStartsWith":"String","GroupIDEndsWith":"String","GroupIDContains":"String","GroupIDLike":"String","GroupIDBetween":["String"],"GroupIDIn":["String"],"ProspectID":"String","ProspectIDStartsWith":"String","ProspectIDEndsWith":"String","ProspectIDContains":"String","ProspectIDLike":"String","ProspectIDBetween":["String"],"ProspectIDIn":["String"],"StaffID":"String","StaffIDStartsWith":"String","StaffIDEndsWith":"String","StaffIDContains":"String","StaffIDLike":"String","StaffIDBetween":["String"],"StaffIDIn":["String"],"DefaultItem":false,"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"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"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":[{"LinkID":"String","GroupID":"String","ProspectID":"String","StaffID":"String","ItemNo":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}