| All Verbs | /api/dimensionvalues/{DimensionId} |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Get a list of dimensionValues for a specified dimension
*/
@Api(Description="Get a list of dimensionValues for a specified dimension")
public static class GetDimensionValuesList
{
/**
* Licensee Id to retrieve dimensionValues for.
*/
@ApiMember(DataType="Guid", Description="Licensee Id to retrieve dimensionValues for.", Name="LicenseeId", ParameterType="query")
public UUID LicenseeId = null;
/**
* Dimension Id to retrieve dimensionValues for.
*/
@ApiMember(DataType="Guid", Description="Dimension Id to retrieve dimensionValues for.", Name="DimensionId", ParameterType="query")
public UUID DimensionId = null;
/**
* RecordStatus of dimensionValues to retrieve. If not set 'A' active dimensionValues are retrieved.
*/
@ApiMember(DataType="string", Description="RecordStatus of dimensionValues to retrieve. If not set 'A' active dimensionValues are retrieved.", Name="RecordStatus", ParameterType="query")
public String RecordStatus = null;
public UUID getLicenseeId() { return LicenseeId; }
public GetDimensionValuesList setLicenseeId(UUID value) { this.LicenseeId = value; return this; }
public UUID getDimensionId() { return DimensionId; }
public GetDimensionValuesList setDimensionId(UUID value) { this.DimensionId = value; return this; }
public String getRecordStatus() { return RecordStatus; }
public GetDimensionValuesList setRecordStatus(String value) { this.RecordStatus = value; return this; }
}
@ApiResponse(Description="A list of dimension values")
public static class GetDimensionValuesListResponse
{
/**
* List of dimensionValues.
*/
@ApiMember(DataType="List<DimensionValueModel>", Description="List of dimensionValues.", Name="DimensionValues", ParameterType="query")
public ArrayList<DimensionValueModel> DimensionValues = null;
public ResponseStatus ResponseStatus = null;
public ArrayList<DimensionValueModel> getDimensionValues() { return DimensionValues; }
public GetDimensionValuesListResponse setDimensionValues(ArrayList<DimensionValueModel> value) { this.DimensionValues = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public GetDimensionValuesListResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class DimensionValueModel
{
/**
* Id of the dimension value.
*/
@ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")
public UUID DimensionValueId = null;
/**
* Dimension Id this value is for.
*/
@ApiMember(Description="Dimension Id this value is for.", ParameterType="body")
public UUID DimensionId = null;
/**
* Name of the dimension value.
*/
@ApiMember(Description="Name of the dimension value.", ParameterType="body")
public String Name = null;
/**
* Description of the dimension value.
*/
@ApiMember(Description="Description of the dimension value.", ParameterType="body")
public String Description = null;
/**
* Short Name for the dimension value.
*/
@ApiMember(Description="Short Name for the dimension value.", ParameterType="body")
public String ShortName = null;
/**
* Id of the colour associated.
*/
@ApiMember(Description="Id of the colour associated.", ParameterType="body")
public UUID TrafficLightId = null;
/**
* Colour associated with the dimension value.
*/
@ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")
public String TrafficLightColour = null;
/**
* Id that links this dimension value to an object.
*/
@ApiMember(Description="Id that links this dimension value to an object.", ParameterType="body")
public UUID ObjectConnectionId = null;
/**
* Owner Id of the dimension value.
*/
@ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")
public UUID OwnerContactId = null;
/**
* Record status of the dimension value.
*/
@ApiMember(Description="Record status of the dimension value.", ParameterType="body")
public String RecordStatus = null;
public UUID getDimensionValueId() { return DimensionValueId; }
public DimensionValueModel setDimensionValueId(UUID value) { this.DimensionValueId = value; return this; }
public UUID getDimensionId() { return DimensionId; }
public DimensionValueModel setDimensionId(UUID value) { this.DimensionId = value; return this; }
public String getName() { return Name; }
public DimensionValueModel setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public DimensionValueModel setDescription(String value) { this.Description = value; return this; }
public String getShortName() { return ShortName; }
public DimensionValueModel setShortName(String value) { this.ShortName = value; return this; }
public UUID getTrafficLightId() { return TrafficLightId; }
public DimensionValueModel setTrafficLightId(UUID value) { this.TrafficLightId = value; return this; }
public String getTrafficLightColour() { return TrafficLightColour; }
public DimensionValueModel setTrafficLightColour(String value) { this.TrafficLightColour = value; return this; }
public UUID getObjectConnectionId() { return ObjectConnectionId; }
public DimensionValueModel setObjectConnectionId(UUID value) { this.ObjectConnectionId = value; return this; }
public UUID getOwnerContactId() { return OwnerContactId; }
public DimensionValueModel setOwnerContactId(UUID value) { this.OwnerContactId = value; return this; }
public String getRecordStatus() { return RecordStatus; }
public DimensionValueModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
}
}
Java GetDimensionValuesList DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/dimensionvalues/{DimensionId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"LicenseeId":"00000000-0000-0000-0000-000000000000","DimensionId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"DimensionValues":[{"DimensionValueId":"00000000-0000-0000-0000-000000000000","DimensionId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","TrafficLightId":"00000000-0000-0000-0000-000000000000","TrafficLightColour":"String","ObjectConnectionId":"00000000-0000-0000-0000-000000000000","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}