Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 | |
JB_Classifications_RecID | query | string | No | |
JB_Classifications_RecIDStartsWith | query | string | No | |
JB_Classifications_RecIDEndsWith | query | string | No | |
JB_Classifications_RecIDContains | query | string | No | |
JB_Classifications_RecIDLike | query | string | No | |
JB_Classifications_RecIDBetween | query | string[] | No | |
JB_Classifications_RecIDIn | query | string[] | No | |
JB_JobCostCentres_RecID | query | string | No | |
JB_JobCostCentres_RecIDStartsWith | query | string | No | |
JB_JobCostCentres_RecIDEndsWith | query | string | No | |
JB_JobCostCentres_RecIDContains | query | string | No | |
JB_JobCostCentres_RecIDLike | query | string | No | |
JB_JobCostCentres_RecIDBetween | query | string[] | No | |
JB_JobCostCentres_RecIDIn | query | string[] | No | |
JB_Stages_RecID | query | string | No | |
JB_Stages_RecIDStartsWith | query | string | No | |
JB_Stages_RecIDEndsWith | query | string | No | |
JB_Stages_RecIDContains | query | string | No | |
JB_Stages_RecIDLike | query | string | No | |
JB_Stages_RecIDBetween | query | string[] | No | |
JB_Stages_RecIDIn | query | string[] | No | |
RowHash | query | byte[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | form | string | No | |
JB_Classifications_RecID | form | string | No | |
JB_JobCostCentres_RecID | form | string | No | |
JB_Stages_RecID | form | string | No | |
RowHash | form | byte[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/reply/JB_JobStagesQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<JB_JobStagesQuery 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>
<JB_Classifications_RecID>String</JB_Classifications_RecID>
<JB_Classifications_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</JB_Classifications_RecIDBetween>
<JB_Classifications_RecIDContains>String</JB_Classifications_RecIDContains>
<JB_Classifications_RecIDEndsWith>String</JB_Classifications_RecIDEndsWith>
<JB_Classifications_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</JB_Classifications_RecIDIn>
<JB_Classifications_RecIDLike>String</JB_Classifications_RecIDLike>
<JB_Classifications_RecIDStartsWith>String</JB_Classifications_RecIDStartsWith>
<JB_JobCostCentres_RecID>String</JB_JobCostCentres_RecID>
<JB_JobCostCentres_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</JB_JobCostCentres_RecIDBetween>
<JB_JobCostCentres_RecIDContains>String</JB_JobCostCentres_RecIDContains>
<JB_JobCostCentres_RecIDEndsWith>String</JB_JobCostCentres_RecIDEndsWith>
<JB_JobCostCentres_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</JB_JobCostCentres_RecIDIn>
<JB_JobCostCentres_RecIDLike>String</JB_JobCostCentres_RecIDLike>
<JB_JobCostCentres_RecIDStartsWith>String</JB_JobCostCentres_RecIDStartsWith>
<JB_Stages_RecID>String</JB_Stages_RecID>
<JB_Stages_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</JB_Stages_RecIDBetween>
<JB_Stages_RecIDContains>String</JB_Stages_RecIDContains>
<JB_Stages_RecIDEndsWith>String</JB_Stages_RecIDEndsWith>
<JB_Stages_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</JB_Stages_RecIDIn>
<JB_Stages_RecIDLike>String</JB_Stages_RecIDLike>
<JB_Stages_RecIDStartsWith>String</JB_Stages_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>
<RowHash>AA==</RowHash>
</JB_JobStagesQuery>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfJB_JobStages7kRqkrSv 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:JB_JobStages> <d2p1:_x003C_JB_Classifications_RecID_x003E_k__BackingField>String</d2p1:_x003C_JB_Classifications_RecID_x003E_k__BackingField> <d2p1:_x003C_JB_JobCostCentres_RecID_x003E_k__BackingField>String</d2p1:_x003C_JB_JobCostCentres_RecID_x003E_k__BackingField> <d2p1:_x003C_JB_Stages_RecID_x003E_k__BackingField>String</d2p1:_x003C_JB_Stages_RecID_x003E_k__BackingField> <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField> <d2p1:_x003C_RowHash_x003E_k__BackingField>AA==</d2p1:_x003C_RowHash_x003E_k__BackingField> </d2p1:JB_JobStages> </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> </QueryResponseOfJB_JobStages7kRqkrSv>