| All Verbs | /api/unitofmeasures/ | ||
|---|---|---|---|
| All Verbs | /api/unitofmeasures/{ApplianceId} |
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Get a list of UOM codes (Unit of Measure)
*/
@Api(Description="Get a list of UOM codes (Unit of Measure)")
public static class GetUOMCodeList
{
/**
* ApplianceId to narrow the UOM Code list down to relevant ones for the appliance.
*/
@ApiMember(DataType="Guid", Description="ApplianceId to narrow the UOM Code list down to relevant ones for the appliance.", Name="ApplianceId", ParameterType="query")
public UUID ApplianceId = null;
public UUID getApplianceId() { return ApplianceId; }
public GetUOMCodeList setApplianceId(UUID value) { this.ApplianceId = value; return this; }
}
@ApiResponse(Description="List of UOM codes (Unit of Measure)")
public static class GetUOMCodeListResponse
{
public ArrayList<UOMModel> UOMCodes = null;
public ResponseStatus ResponseStatus = null;
public ArrayList<UOMModel> getUomCodes() { return UOMCodes; }
public GetUOMCodeListResponse setUomCodes(ArrayList<UOMModel> value) { this.UOMCodes = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public GetUOMCodeListResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class UOMModel
{
public String Code = null;
public String Name = null;
public String Description = null;
public String Symbol = null;
public String getCode() { return Code; }
public UOMModel setCode(String value) { this.Code = value; return this; }
public String getName() { return Name; }
public UOMModel setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public UOMModel setDescription(String value) { this.Description = value; return this; }
public String getSymbol() { return Symbol; }
public UOMModel setSymbol(String value) { this.Symbol = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/unitofmeasures/ HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
UOMCodes:
[
{
Code: String,
Name: String,
Description: String,
Symbol: String
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}