JiwaAPI

RA_ShipNotesQuery

**RA_ShipNotesQuery** Parameters:
Name	Parameter	Data Type	Required
RecID	query	string	No
RecIDStartsWith	query	string	No
RecIDEndsWith	query	string	No
RecIDContains	query	string	No
RecIDLike	query	string	No
RecIDBetween	query	string[]	No
RecIDIn	query	string[]	No
RA_ShipMain_RecID	query	string	No
RA_ShipMain_RecIDStartsWith	query	string	No
RA_ShipMain_RecIDEndsWith	query	string	No
RA_ShipMain_RecIDContains	query	string	No
RA_ShipMain_RecIDLike	query	string	No
RA_ShipMain_RecIDBetween	query	string[]	No
RA_ShipMain_RecIDIn	query	string[]	No
NoteTypeID	query	string	No
NoteTypeIDStartsWith	query	string	No
NoteTypeIDEndsWith	query	string	No
NoteTypeIDContains	query	string	No
NoteTypeIDLike	query	string	No
NoteTypeIDBetween	query	string[]	No
NoteTypeIDIn	query	string[]	No
LastSavedDateTime	query	DateTime?	No
LastSavedDateTimeGreaterThanOrEqualTo	query	DateTime?	No
LastSavedDateTimeGreaterThan	query	DateTime?	No
LastSavedDateTimeLessThan	query	DateTime?	No
LastSavedDateTimeLessThanOrEqualTo	query	DateTime?	No
LastSavedDateTimeNotEqualTo	query	DateTime?	No
LastSavedDateTimeBetween	query	DateTime[]	No
LastSavedDateTimeIn	query	DateTime[]	No
LastSavedByStaffID	query	string	No
LastSavedByStaffIDStartsWith	query	string	No
LastSavedByStaffIDEndsWith	query	string	No
LastSavedByStaffIDContains	query	string	No
LastSavedByStaffIDLike	query	string	No
LastSavedByStaffIDBetween	query	string[]	No
LastSavedByStaffIDIn	query	string[]	No
NoteText	query	string	No
NoteTextStartsWith	query	string	No
NoteTextEndsWith	query	string	No
NoteTextContains	query	string	No
NoteTextLike	query	string	No
NoteTextBetween	query	string[]	No
NoteTextIn	query	string[]	No
ItemNo	query	int?	No
ItemNoGreaterThanOrEqualTo	query	int?	No
ItemNoGreaterThan	query	int?	No
ItemNoLessThan	query	int?	No
ItemNoLessThanOrEqualTo	query	int?	No
ItemNoNotEqualTo	query	int?	No
ItemNoBetween	query	int[]	No
ItemNoIn	query	int[]	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
Skip	form	int?	No
Take	form	int?	No
OrderBy	form	string	No
OrderByDesc	form	string	No
Include	form	string	No
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**RA_ShipNotes** Parameters:
Name	Parameter	Data Type	Required
RecID	form	string	No
RA_ShipMain_RecID	form	string	No
NoteTypeID	form	string	No
LastSavedDateTime	form	DateTime	No
LastSavedByStaffID	form	string	No
NoteText	form	string	No
ItemNo	form	int	No

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<T>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

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

HTTP + XML

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

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

<RA_ShipNotesQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <ItemNo>0</ItemNo>
  <ItemNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ItemNoBetween>
  <ItemNoGreaterThan>0</ItemNoGreaterThan>
  <ItemNoGreaterThanOrEqualTo>0</ItemNoGreaterThanOrEqualTo>
  <ItemNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ItemNoIn>
  <ItemNoLessThan>0</ItemNoLessThan>
  <ItemNoLessThanOrEqualTo>0</ItemNoLessThanOrEqualTo>
  <ItemNoNotEqualTo>0</ItemNoNotEqualTo>
  <LastSavedByStaffID>String</LastSavedByStaffID>
  <LastSavedByStaffIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </LastSavedByStaffIDBetween>
  <LastSavedByStaffIDContains>String</LastSavedByStaffIDContains>
  <LastSavedByStaffIDEndsWith>String</LastSavedByStaffIDEndsWith>
  <LastSavedByStaffIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </LastSavedByStaffIDIn>
  <LastSavedByStaffIDLike>String</LastSavedByStaffIDLike>
  <LastSavedByStaffIDStartsWith>String</LastSavedByStaffIDStartsWith>
  <LastSavedDateTime>0001-01-01T00:00:00</LastSavedDateTime>
  <LastSavedDateTimeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastSavedDateTimeBetween>
  <LastSavedDateTimeGreaterThan>0001-01-01T00:00:00</LastSavedDateTimeGreaterThan>
  <LastSavedDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeGreaterThanOrEqualTo>
  <LastSavedDateTimeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastSavedDateTimeIn>
  <LastSavedDateTimeLessThan>0001-01-01T00:00:00</LastSavedDateTimeLessThan>
  <LastSavedDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeLessThanOrEqualTo>
  <LastSavedDateTimeNotEqualTo>0001-01-01T00:00:00</LastSavedDateTimeNotEqualTo>
  <NoteText>String</NoteText>
  <NoteTextBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NoteTextBetween>
  <NoteTextContains>String</NoteTextContains>
  <NoteTextEndsWith>String</NoteTextEndsWith>
  <NoteTextIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NoteTextIn>
  <NoteTextLike>String</NoteTextLike>
  <NoteTextStartsWith>String</NoteTextStartsWith>
  <NoteTypeID>String</NoteTypeID>
  <NoteTypeIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NoteTypeIDBetween>
  <NoteTypeIDContains>String</NoteTypeIDContains>
  <NoteTypeIDEndsWith>String</NoteTypeIDEndsWith>
  <NoteTypeIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NoteTypeIDIn>
  <NoteTypeIDLike>String</NoteTypeIDLike>
  <NoteTypeIDStartsWith>String</NoteTypeIDStartsWith>
  <RA_ShipMain_RecID>String</RA_ShipMain_RecID>
  <RA_ShipMain_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RA_ShipMain_RecIDBetween>
  <RA_ShipMain_RecIDContains>String</RA_ShipMain_RecIDContains>
  <RA_ShipMain_RecIDEndsWith>String</RA_ShipMain_RecIDEndsWith>
  <RA_ShipMain_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RA_ShipMain_RecIDIn>
  <RA_ShipMain_RecIDLike>String</RA_ShipMain_RecIDLike>
  <RA_ShipMain_RecIDStartsWith>String</RA_ShipMain_RecIDStartsWith>
  <RecID>String</RecID>
  <RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecIDBetween>
  <RecIDContains>String</RecIDContains>
  <RecIDEndsWith>String</RecIDEndsWith>
  <RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecIDIn>
  <RecIDLike>String</RecIDLike>
  <RecIDStartsWith>String</RecIDStartsWith>
</RA_ShipNotesQuery>

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

<QueryResponseOfRA_ShipNotes7kRqkrSv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
    <d2p1:RA_ShipNotes>
      <d2p1:_x003C_ItemNo_x003E_k__BackingField>0</d2p1:_x003C_ItemNo_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedByStaffID_x003E_k__BackingField>String</d2p1:_x003C_LastSavedByStaffID_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_NoteText_x003E_k__BackingField>String</d2p1:_x003C_NoteText_x003E_k__BackingField>
      <d2p1:_x003C_NoteTypeID_x003E_k__BackingField>String</d2p1:_x003C_NoteTypeID_x003E_k__BackingField>
      <d2p1:_x003C_RA_ShipMain_RecID_x003E_k__BackingField>String</d2p1:_x003C_RA_ShipMain_RecID_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
    </d2p1:RA_ShipNotes>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfRA_ShipNotes7kRqkrSv>