JiwaAPI

<back to all web services

SY_DocumentLinksQuery

Requires Authentication
SY_DocumentLinksQuery Parameters:
NameParameterData TypeRequiredDescription
PKIDquerystringNo
PKIDStartsWithquerystringNo
PKIDEndsWithquerystringNo
PKIDContainsquerystringNo
PKIDLikequerystringNo
PKIDBetweenquerystring[]No
PKIDInquerystring[]No
SourceDocDescquerystringNo
SourceDocDescStartsWithquerystringNo
SourceDocDescEndsWithquerystringNo
SourceDocDescContainsquerystringNo
SourceDocDescLikequerystringNo
SourceDocDescBetweenquerystring[]No
SourceDocDescInquerystring[]No
SourceDocIDquerystringNo
SourceDocIDStartsWithquerystringNo
SourceDocIDEndsWithquerystringNo
SourceDocIDContainsquerystringNo
SourceDocIDLikequerystringNo
SourceDocIDBetweenquerystring[]No
SourceDocIDInquerystring[]No
DestDocDescquerystringNo
DestDocDescStartsWithquerystringNo
DestDocDescEndsWithquerystringNo
DestDocDescContainsquerystringNo
DestDocDescLikequerystringNo
DestDocDescBetweenquerystring[]No
DestDocDescInquerystring[]No
DestDocIDquerystringNo
DestDocIDStartsWithquerystringNo
DestDocIDEndsWithquerystringNo
DestDocIDContainsquerystringNo
DestDocIDLikequerystringNo
DestDocIDBetweenquerystring[]No
DestDocIDInquerystring[]No
LinkDescriptorquerystringNo
LinkDescriptorStartsWithquerystringNo
LinkDescriptorEndsWithquerystringNo
LinkDescriptorContainsquerystringNo
LinkDescriptorLikequerystringNo
LinkDescriptorBetweenquerystring[]No
LinkDescriptorInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
DateCreatedqueryDateTime?No
DateCreatedGreaterThanOrEqualToqueryDateTime?No
DateCreatedGreaterThanqueryDateTime?No
DateCreatedLessThanqueryDateTime?No
DateCreatedLessThanOrEqualToqueryDateTime?No
DateCreatedNotEqualToqueryDateTime?No
DateCreatedBetweenqueryNullable<DateTime>[]No
DateCreatedInqueryNullable<DateTime>[]No
StaffIDquerystringNo
StaffIDStartsWithquerystringNo
StaffIDEndsWithquerystringNo
StaffIDContainsquerystringNo
StaffIDLikequerystringNo
StaffIDBetweenquerystring[]No
StaffIDInquerystring[]No
StaffNamequerystringNo
StaffNameStartsWithquerystringNo
StaffNameEndsWithquerystringNo
StaffNameContainsquerystringNo
StaffNameLikequerystringNo
StaffNameBetweenquerystring[]No
StaffNameInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_DocumentLinks Parameters:
NameParameterData TypeRequiredDescription
PKIDformstringNo
SourceDocDescformstringNo
SourceDocIDformstringNo
DestDocDescformstringNo
DestDocIDformstringNo
LinkDescriptorformstringNo
LastSavedDateTimeformDateTime?No
DateCreatedformDateTime?No
StaffIDformstringNo
StaffNameformstringNo
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/SY_DocumentLinksQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"PKID":"String","PKIDStartsWith":"String","PKIDEndsWith":"String","PKIDContains":"String","PKIDLike":"String","PKIDBetween":["String"],"PKIDIn":["String"],"SourceDocDesc":"String","SourceDocDescStartsWith":"String","SourceDocDescEndsWith":"String","SourceDocDescContains":"String","SourceDocDescLike":"String","SourceDocDescBetween":["String"],"SourceDocDescIn":["String"],"SourceDocID":"String","SourceDocIDStartsWith":"String","SourceDocIDEndsWith":"String","SourceDocIDContains":"String","SourceDocIDLike":"String","SourceDocIDBetween":["String"],"SourceDocIDIn":["String"],"DestDocDesc":"String","DestDocDescStartsWith":"String","DestDocDescEndsWith":"String","DestDocDescContains":"String","DestDocDescLike":"String","DestDocDescBetween":["String"],"DestDocDescIn":["String"],"DestDocID":"String","DestDocIDStartsWith":"String","DestDocIDEndsWith":"String","DestDocIDContains":"String","DestDocIDLike":"String","DestDocIDBetween":["String"],"DestDocIDIn":["String"],"LinkDescriptor":"String","LinkDescriptorStartsWith":"String","LinkDescriptorEndsWith":"String","LinkDescriptorContains":"String","LinkDescriptorLike":"String","LinkDescriptorBetween":["String"],"LinkDescriptorIn":["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"],"DateCreated":"0001-01-01T00:00:00.0000000","DateCreatedGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateCreatedGreaterThan":"0001-01-01T00:00:00.0000000","DateCreatedLessThan":"0001-01-01T00:00:00.0000000","DateCreatedLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateCreatedNotEqualTo":"0001-01-01T00:00:00.0000000","DateCreatedBetween":["0001-01-01T00:00:00.0000000"],"DateCreatedIn":["0001-01-01T00:00:00.0000000"],"StaffID":"String","StaffIDStartsWith":"String","StaffIDEndsWith":"String","StaffIDContains":"String","StaffIDLike":"String","StaffIDBetween":["String"],"StaffIDIn":["String"],"StaffName":"String","StaffNameStartsWith":"String","StaffNameEndsWith":"String","StaffNameContains":"String","StaffNameLike":"String","StaffNameBetween":["String"],"StaffNameIn":["String"],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"PKID":"String","SourceDocDesc":"String","SourceDocID":"String","DestDocDesc":"String","DestDocID":"String","LinkDescriptor":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","DateCreated":"0001-01-01T00:00:00.0000000","StaffID":"String","StaffName":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}