JiwaAPI

<back to all web services

SM_JobEquipmentQuery

Requires Authentication
SM_JobEquipmentQuery Parameters:
NameParameterData TypeRequiredDescription
EquipmentIDquerystringNo
EquipmentIDStartsWithquerystringNo
EquipmentIDEndsWithquerystringNo
EquipmentIDContainsquerystringNo
EquipmentIDLikequerystringNo
EquipmentIDBetweenquerystring[]No
EquipmentIDInquerystring[]No
JobIDquerystringNo
JobIDStartsWithquerystringNo
JobIDEndsWithquerystringNo
JobIDContainsquerystringNo
JobIDLikequerystringNo
JobIDBetweenquerystring[]No
JobIDInquerystring[]No
InventoryIDquerystringNo
InventoryIDStartsWithquerystringNo
InventoryIDEndsWithquerystringNo
InventoryIDContainsquerystringNo
InventoryIDLikequerystringNo
InventoryIDBetweenquerystring[]No
InventoryIDInquerystring[]No
PartNoquerystringNo
PartNoStartsWithquerystringNo
PartNoEndsWithquerystringNo
PartNoContainsquerystringNo
PartNoLikequerystringNo
PartNoBetweenquerystring[]No
PartNoInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
NotesquerystringNo
NotesStartsWithquerystringNo
NotesEndsWithquerystringNo
NotesContainsquerystringNo
NotesLikequerystringNo
NotesBetweenquerystring[]No
NotesInquerystring[]No
SerialNumberquerystringNo
SerialNumberStartsWithquerystringNo
SerialNumberEndsWithquerystringNo
SerialNumberContainsquerystringNo
SerialNumberLikequerystringNo
SerialNumberBetweenquerystring[]No
SerialNumberInquerystring[]No
Damagedqueryint?No
DamagedGreaterThanOrEqualToqueryint?No
DamagedGreaterThanqueryint?No
DamagedLessThanqueryint?No
DamagedLessThanOrEqualToqueryint?No
DamagedNotEqualToqueryint?No
DamagedBetweenqueryint[]No
DamagedInqueryint[]No
WarrantyItemIDquerystringNo
WarrantyItemIDStartsWithquerystringNo
WarrantyItemIDEndsWithquerystringNo
WarrantyItemIDContainsquerystringNo
WarrantyItemIDLikequerystringNo
WarrantyItemIDBetweenquerystring[]No
WarrantyItemIDInquerystring[]No
ReferencequerystringNo
ReferenceStartsWithquerystringNo
ReferenceEndsWithquerystringNo
ReferenceContainsquerystringNo
ReferenceLikequerystringNo
ReferenceBetweenquerystring[]No
ReferenceInquerystring[]No
DateSentqueryDateTime?No
DateSentGreaterThanOrEqualToqueryDateTime?No
DateSentGreaterThanqueryDateTime?No
DateSentLessThanqueryDateTime?No
DateSentLessThanOrEqualToqueryDateTime?No
DateSentNotEqualToqueryDateTime?No
DateSentBetweenqueryNullable<DateTime>[]No
DateSentInqueryNullable<DateTime>[]No
DateReturnqueryDateTime?No
DateReturnGreaterThanOrEqualToqueryDateTime?No
DateReturnGreaterThanqueryDateTime?No
DateReturnLessThanqueryDateTime?No
DateReturnLessThanOrEqualToqueryDateTime?No
DateReturnNotEqualToqueryDateTime?No
DateReturnBetweenqueryNullable<DateTime>[]No
DateReturnInqueryNullable<DateTime>[]No
Statusquerybyte?No
StatusGreaterThanOrEqualToquerybyte?No
StatusGreaterThanquerybyte?No
StatusLessThanquerybyte?No
StatusLessThanOrEqualToquerybyte?No
StatusNotEqualToquerybyte?No
StatusBetweenqueryNullable<Byte>[]No
StatusInqueryNullable<Byte>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SM_JobEquipment Parameters:
NameParameterData TypeRequiredDescription
EquipmentIDformstringNo
JobIDformstringNo
InventoryIDformstringNo
PartNoformstringNo
DescriptionformstringNo
NotesformstringNo
SerialNumberformstringNo
DamagedformintNo
WarrantyItemIDformstringNo
ReferenceformstringNo
DateSentformDateTime?No
DateReturnformDateTime?No
Statusformbyte?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/SM_JobEquipmentQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"EquipmentID":"String","EquipmentIDStartsWith":"String","EquipmentIDEndsWith":"String","EquipmentIDContains":"String","EquipmentIDLike":"String","EquipmentIDBetween":["String"],"EquipmentIDIn":["String"],"JobID":"String","JobIDStartsWith":"String","JobIDEndsWith":"String","JobIDContains":"String","JobIDLike":"String","JobIDBetween":["String"],"JobIDIn":["String"],"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["String"],"PartNo":"String","PartNoStartsWith":"String","PartNoEndsWith":"String","PartNoContains":"String","PartNoLike":"String","PartNoBetween":["String"],"PartNoIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"Notes":"String","NotesStartsWith":"String","NotesEndsWith":"String","NotesContains":"String","NotesLike":"String","NotesBetween":["String"],"NotesIn":["String"],"SerialNumber":"String","SerialNumberStartsWith":"String","SerialNumberEndsWith":"String","SerialNumberContains":"String","SerialNumberLike":"String","SerialNumberBetween":["String"],"SerialNumberIn":["String"],"Damaged":0,"DamagedGreaterThanOrEqualTo":0,"DamagedGreaterThan":0,"DamagedLessThan":0,"DamagedLessThanOrEqualTo":0,"DamagedNotEqualTo":0,"DamagedBetween":[0],"DamagedIn":[0],"WarrantyItemID":"String","WarrantyItemIDStartsWith":"String","WarrantyItemIDEndsWith":"String","WarrantyItemIDContains":"String","WarrantyItemIDLike":"String","WarrantyItemIDBetween":["String"],"WarrantyItemIDIn":["String"],"Reference":"String","ReferenceStartsWith":"String","ReferenceEndsWith":"String","ReferenceContains":"String","ReferenceLike":"String","ReferenceBetween":["String"],"ReferenceIn":["String"],"DateSent":"0001-01-01T00:00:00.0000000","DateSentGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateSentGreaterThan":"0001-01-01T00:00:00.0000000","DateSentLessThan":"0001-01-01T00:00:00.0000000","DateSentLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateSentNotEqualTo":"0001-01-01T00:00:00.0000000","DateSentBetween":["0001-01-01T00:00:00.0000000"],"DateSentIn":["0001-01-01T00:00:00.0000000"],"DateReturn":"0001-01-01T00:00:00.0000000","DateReturnGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateReturnGreaterThan":"0001-01-01T00:00:00.0000000","DateReturnLessThan":"0001-01-01T00:00:00.0000000","DateReturnLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateReturnNotEqualTo":"0001-01-01T00:00:00.0000000","DateReturnBetween":["0001-01-01T00:00:00.0000000"],"DateReturnIn":["0001-01-01T00:00:00.0000000"],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":[0],"StatusIn":[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":[{"EquipmentID":"String","JobID":"String","InventoryID":"String","PartNo":"String","Description":"String","Notes":"String","SerialNumber":"String","WarrantyItemID":"String","Reference":"String","DateSent":"0001-01-01T00:00:00.0000000","DateReturn":"0001-01-01T00:00:00.0000000","Status":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}