Platform API

<back to all web services

GetIncidentTypes

Get safety incident Types

Requires Authentication
The following routes are available for this service:
All Verbs/api/lists/statuses/incidenttypes
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Get safety incident Types
    */
    @Api(Description="Get safety incident Types")
    public static class GetIncidentTypes
    {
        
    }

    @ApiResponse(Description="List items for a list")
    public static class GetListItemsResponse
    {
        public ArrayList<ListItemModel> ListItems = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<ListItemModel> getListItems() { return ListItems; }
        public GetListItemsResponse setListItems(ArrayList<ListItemModel> value) { this.ListItems = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetListItemsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class ListItemModel
    {
        public UUID ListItemId = null;
        public String Name = null;
        public String Description = null;
        public String ShortName = null;
        public Boolean IsDefault = null;
        public Integer Order = null;
        public UUID ListItemTrafficLightId = null;
        public UUID PrimaryListItemImageId = null;
        public String PrimaryListItemImageUrl = null;
        public String PrimaryImageThumbnailUrl = null;
        public UUID OwnerContactId = null;
        public String RecordStatus = null;
        
        public UUID getListItemId() { return ListItemId; }
        public ListItemModel setListItemId(UUID value) { this.ListItemId = value; return this; }
        public String getName() { return Name; }
        public ListItemModel setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public ListItemModel setDescription(String value) { this.Description = value; return this; }
        public String getShortName() { return ShortName; }
        public ListItemModel setShortName(String value) { this.ShortName = value; return this; }
        public Boolean getIsDefault() { return IsDefault; }
        public ListItemModel setIsDefault(Boolean value) { this.IsDefault = value; return this; }
        public Integer getOrder() { return Order; }
        public ListItemModel setOrder(Integer value) { this.Order = value; return this; }
        public UUID getListItemTrafficLightId() { return ListItemTrafficLightId; }
        public ListItemModel setListItemTrafficLightId(UUID value) { this.ListItemTrafficLightId = value; return this; }
        public UUID getPrimaryListItemImageId() { return PrimaryListItemImageId; }
        public ListItemModel setPrimaryListItemImageId(UUID value) { this.PrimaryListItemImageId = value; return this; }
        public String getPrimaryListItemImageUrl() { return PrimaryListItemImageUrl; }
        public ListItemModel setPrimaryListItemImageUrl(String value) { this.PrimaryListItemImageUrl = value; return this; }
        public String getPrimaryImageThumbnailUrl() { return PrimaryImageThumbnailUrl; }
        public ListItemModel setPrimaryImageThumbnailUrl(String value) { this.PrimaryImageThumbnailUrl = value; return this; }
        public UUID getOwnerContactId() { return OwnerContactId; }
        public ListItemModel setOwnerContactId(UUID value) { this.OwnerContactId = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public ListItemModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
    }

}

Java GetIncidentTypes DTOs

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 /api/lists/statuses/incidenttypes HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetIncidentTypes xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetListItemsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ListItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:ListItemModel>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:IsDefault>false</d2p1:IsDefault>
      <d2p1:ListItemId>00000000-0000-0000-0000-000000000000</d2p1:ListItemId>
      <d2p1:ListItemTrafficLightId>00000000-0000-0000-0000-000000000000</d2p1:ListItemTrafficLightId>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Order>0</d2p1:Order>
      <d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
      <d2p1:PrimaryImageThumbnailUrl>String</d2p1:PrimaryImageThumbnailUrl>
      <d2p1:PrimaryListItemImageId>00000000-0000-0000-0000-000000000000</d2p1:PrimaryListItemImageId>
      <d2p1:PrimaryListItemImageUrl>String</d2p1:PrimaryListItemImageUrl>
      <d2p1:RecordStatus>String</d2p1:RecordStatus>
      <d2p1:ShortName>String</d2p1:ShortName>
    </d2p1:ListItemModel>
  </ListItems>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1: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>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1: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>
    </d2p1:Meta>
  </ResponseStatus>
</GetListItemsResponse>