| GET | /api/safetycommitment | ||
|---|---|---|---|
| GET | /api/terms |
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Retrieve details of the specified terms for the specified licensee and contact.
*/
@Api(Description="Retrieve details of the specified terms for the specified licensee and contact.")
public static class GetTermsDetails
{
/**
* Accept terms for the specified licensee contact id.
*/
@ApiMember(DataType="Guid", Description="Accept terms for the specified licensee contact id.", IsRequired=true, Name="LicenseeContactId")
public UUID LicenseeContactId = null;
/**
* Terms are being accepted by the specified contact id.
*/
@ApiMember(DataType="Guid", Description="Terms are being accepted by the specified contact id.", IsRequired=true, Name="ContactId")
public UUID ContactId = null;
/**
* Contact Type e.g Real Person or Real Organisation. Defaults to real person.
*/
@ApiMember(DataType="Guid", Description="Contact Type e.g Real Person or Real Organisation. Defaults to real person.", IsRequired=true, Name="ContactTypeId")
public UUID ContactTypeId = null;
/**
* Accept terms for the specified appliance id. This is not required for Safety Commitment.
*/
@ApiMember(DataType="Guid", Description="Accept terms for the specified appliance id. This is not required for Safety Commitment.", Name="ApplianceId")
public UUID ApplianceId = null;
public UUID getLicenseeContactId() { return LicenseeContactId; }
public GetTermsDetails setLicenseeContactId(UUID value) { this.LicenseeContactId = value; return this; }
public UUID getContactId() { return ContactId; }
public GetTermsDetails setContactId(UUID value) { this.ContactId = value; return this; }
public UUID getContactTypeId() { return ContactTypeId; }
public GetTermsDetails setContactTypeId(UUID value) { this.ContactTypeId = value; return this; }
public UUID getApplianceId() { return ApplianceId; }
public GetTermsDetails setApplianceId(UUID value) { this.ApplianceId = value; return this; }
}
public static class GetTermsDetailsResponse
{
/**
* Should Commitment to Safety be displayed?
*/
@ApiMember(Description="Should Commitment to Safety be displayed?", Name="DisplaySafetyCommitment")
public Boolean DisplaySafetyCommitment = null;
/**
* Commitment to Safety HTML content.
*/
@ApiMember(Description="Commitment to Safety HTML content.", Name="SafetyCommitmentContent")
public String SafetyCommitmentContent = null;
public ResponseStatus ResponseStatus = null;
public Boolean isDisplaySafetyCommitment() { return DisplaySafetyCommitment; }
public GetTermsDetailsResponse setDisplaySafetyCommitment(Boolean value) { this.DisplaySafetyCommitment = value; return this; }
public String getSafetyCommitmentContent() { return SafetyCommitmentContent; }
public GetTermsDetailsResponse setSafetyCommitmentContent(String value) { this.SafetyCommitmentContent = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public GetTermsDetailsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = 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.
GET /api/safetycommitment HTTP/1.1 Host: pfapi.pstpf.com.au Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
DisplaySafetyCommitment: False,
SafetyCommitmentContent: String,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}