JiwaAPI

<back to all web services

BM_InstructionCustomValuesQuery

Requires Authentication
BM_InstructionCustomValuesQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
BM_Instructions_RecIDquerystringNo
BM_Instructions_RecIDStartsWithquerystringNo
BM_Instructions_RecIDEndsWithquerystringNo
BM_Instructions_RecIDContainsquerystringNo
BM_Instructions_RecIDLikequerystringNo
BM_Instructions_RecIDBetweenquerystring[]No
BM_Instructions_RecIDInquerystring[]No
BM_InstructionCustomFields_RecIDquerystringNo
BM_InstructionCustomFields_RecIDStartsWithquerystringNo
BM_InstructionCustomFields_RecIDEndsWithquerystringNo
BM_InstructionCustomFields_RecIDContainsquerystringNo
BM_InstructionCustomFields_RecIDLikequerystringNo
BM_InstructionCustomFields_RecIDBetweenquerystring[]No
BM_InstructionCustomFields_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_InstructionCustomValues Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
BM_Instructions_RecIDformstringNo
BM_InstructionCustomFields_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 .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/BM_InstructionCustomValuesQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BM_InstructionCustomValuesQuery 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>
  <BM_InstructionCustomFields_RecID>String</BM_InstructionCustomFields_RecID>
  <BM_InstructionCustomFields_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BM_InstructionCustomFields_RecIDBetween>
  <BM_InstructionCustomFields_RecIDContains>String</BM_InstructionCustomFields_RecIDContains>
  <BM_InstructionCustomFields_RecIDEndsWith>String</BM_InstructionCustomFields_RecIDEndsWith>
  <BM_InstructionCustomFields_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BM_InstructionCustomFields_RecIDIn>
  <BM_InstructionCustomFields_RecIDLike>String</BM_InstructionCustomFields_RecIDLike>
  <BM_InstructionCustomFields_RecIDStartsWith>String</BM_InstructionCustomFields_RecIDStartsWith>
  <BM_Instructions_RecID>String</BM_Instructions_RecID>
  <BM_Instructions_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BM_Instructions_RecIDBetween>
  <BM_Instructions_RecIDContains>String</BM_Instructions_RecIDContains>
  <BM_Instructions_RecIDEndsWith>String</BM_Instructions_RecIDEndsWith>
  <BM_Instructions_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BM_Instructions_RecIDIn>
  <BM_Instructions_RecIDLike>String</BM_Instructions_RecIDLike>
  <BM_Instructions_RecIDStartsWith>String</BM_Instructions_RecIDStartsWith>
  <Contents>String</Contents>
  <ContentsBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ContentsBetween>
  <ContentsContains>String</ContentsContains>
  <ContentsEndsWith>String</ContentsEndsWith>
  <ContentsIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ContentsIn>
  <ContentsLike>String</ContentsLike>
  <ContentsStartsWith>String</ContentsStartsWith>
  <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>
  <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>
</BM_InstructionCustomValuesQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfBM_InstructionCustomValues7kRqkrSv 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:BM_InstructionCustomValues>
      <d2p1:_x003C_BM_InstructionCustomFields_RecID_x003E_k__BackingField>String</d2p1:_x003C_BM_InstructionCustomFields_RecID_x003E_k__BackingField>
      <d2p1:_x003C_BM_Instructions_RecID_x003E_k__BackingField>String</d2p1:_x003C_BM_Instructions_RecID_x003E_k__BackingField>
      <d2p1:_x003C_Contents_x003E_k__BackingField>String</d2p1:_x003C_Contents_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
    </d2p1:BM_InstructionCustomValues>
  </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>
</QueryResponseOfBM_InstructionCustomValues7kRqkrSv>