JiwaAPI

<back to all web services

SH_ApportionedCostsAmountsQuery

Requires Authentication
SH_ApportionedCostsAmountsQuery Parameters:
NameParameterData TypeRequiredDescription
CostsAmountsIDquerystringNo
CostsAmountsIDStartsWithquerystringNo
CostsAmountsIDEndsWithquerystringNo
CostsAmountsIDContainsquerystringNo
CostsAmountsIDLikequerystringNo
CostsAmountsIDBetweenquerystring[]No
CostsAmountsIDInquerystring[]No
ShipmentLineIDquerystringNo
ShipmentLineIDStartsWithquerystringNo
ShipmentLineIDEndsWithquerystringNo
ShipmentLineIDContainsquerystringNo
ShipmentLineIDLikequerystringNo
ShipmentLineIDBetweenquerystring[]No
ShipmentLineIDInquerystring[]No
CostsIDquerystringNo
CostsIDStartsWithquerystringNo
CostsIDEndsWithquerystringNo
CostsIDContainsquerystringNo
CostsIDLikequerystringNo
CostsIDBetweenquerystring[]No
CostsIDInquerystring[]No
Amountquerydecimal?No
AmountGreaterThanOrEqualToquerydecimal?No
AmountGreaterThanquerydecimal?No
AmountLessThanquerydecimal?No
AmountLessThanOrEqualToquerydecimal?No
AmountNotEqualToquerydecimal?No
AmountBetweenqueryNullable<Decimal>[]No
AmountInqueryNullable<Decimal>[]No
IncludeFlagquerybool?No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SH_ApportionedCostsAmounts Parameters:
NameParameterData TypeRequiredDescription
CostsAmountsIDformstringNo
ShipmentLineIDformstringNo
CostsIDformstringNo
Amountformdecimal?No
IncludeFlagformboolNo
RowHashformbyte[]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 .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/SH_ApportionedCostsAmountsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SH_ApportionedCostsAmountsQuery 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>
  <Amount>0</Amount>
  <AmountBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </AmountBetween>
  <AmountGreaterThan>0</AmountGreaterThan>
  <AmountGreaterThanOrEqualTo>0</AmountGreaterThanOrEqualTo>
  <AmountIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </AmountIn>
  <AmountLessThan>0</AmountLessThan>
  <AmountLessThanOrEqualTo>0</AmountLessThanOrEqualTo>
  <AmountNotEqualTo>0</AmountNotEqualTo>
  <CostsAmountsID>String</CostsAmountsID>
  <CostsAmountsIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CostsAmountsIDBetween>
  <CostsAmountsIDContains>String</CostsAmountsIDContains>
  <CostsAmountsIDEndsWith>String</CostsAmountsIDEndsWith>
  <CostsAmountsIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CostsAmountsIDIn>
  <CostsAmountsIDLike>String</CostsAmountsIDLike>
  <CostsAmountsIDStartsWith>String</CostsAmountsIDStartsWith>
  <CostsID>String</CostsID>
  <CostsIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CostsIDBetween>
  <CostsIDContains>String</CostsIDContains>
  <CostsIDEndsWith>String</CostsIDEndsWith>
  <CostsIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CostsIDIn>
  <CostsIDLike>String</CostsIDLike>
  <CostsIDStartsWith>String</CostsIDStartsWith>
  <IncludeFlag>false</IncludeFlag>
  <RowHash>AA==</RowHash>
  <ShipmentLineID>String</ShipmentLineID>
  <ShipmentLineIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ShipmentLineIDBetween>
  <ShipmentLineIDContains>String</ShipmentLineIDContains>
  <ShipmentLineIDEndsWith>String</ShipmentLineIDEndsWith>
  <ShipmentLineIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ShipmentLineIDIn>
  <ShipmentLineIDLike>String</ShipmentLineIDLike>
  <ShipmentLineIDStartsWith>String</ShipmentLineIDStartsWith>
</SH_ApportionedCostsAmountsQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSH_ApportionedCostsAmounts7kRqkrSv 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:SH_ApportionedCostsAmounts>
      <d2p1:_x003C_Amount_x003E_k__BackingField>0</d2p1:_x003C_Amount_x003E_k__BackingField>
      <d2p1:_x003C_CostsAmountsID_x003E_k__BackingField>String</d2p1:_x003C_CostsAmountsID_x003E_k__BackingField>
      <d2p1:_x003C_CostsID_x003E_k__BackingField>String</d2p1:_x003C_CostsID_x003E_k__BackingField>
      <d2p1:_x003C_IncludeFlag_x003E_k__BackingField>false</d2p1:_x003C_IncludeFlag_x003E_k__BackingField>
      <d2p1:_x003C_RowHash_x003E_k__BackingField>AA==</d2p1:_x003C_RowHash_x003E_k__BackingField>
      <d2p1:_x003C_ShipmentLineID_x003E_k__BackingField>String</d2p1:_x003C_ShipmentLineID_x003E_k__BackingField>
    </d2p1:SH_ApportionedCostsAmounts>
  </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>
</QueryResponseOfSH_ApportionedCostsAmounts7kRqkrSv>