Platform API

<back to all web services

GetContactSearchStatuses

Get lists related to contact searches - for e.g. contact types and contact statuses

Requires Authentication
The following routes are available for this service:
All Verbs/api/lists/contactsearch/statuses
import Foundation
import ServiceStack

/**
* Get lists related to contact searches - for e.g. contact types and contact statuses
*/
// @Api(Description="Get lists related to contact searches - for e.g. contact types and contact statuses")
public class GetContactSearchStatuses : Codable
{
    required public init(){}
}

// @ApiResponse(Description="List items for a list")
public class GetListItemsResponse : Codable
{
    public var listItems:[ListItemModel]
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ListItemModel : Codable
{
    public var listItemId:String
    public var name:String
    public var Description:String
    public var shortName:String
    public var isDefault:Bool
    public var order:Int
    public var listItemTrafficLightId:String
    public var primaryListItemImageId:String
    public var primaryListItemImageUrl:String
    public var primaryImageThumbnailUrl:String
    public var ownerContactId:String
    public var recordStatus:String

    required public init(){}
}


Swift GetContactSearchStatuses DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/lists/contactsearch/statuses 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

{
	ListItems: 
	[
		{
			Name: String,
			Description: String,
			ShortName: String,
			IsDefault: False,
			Order: 0,
			PrimaryListItemImageUrl: String,
			PrimaryImageThumbnailUrl: String,
			RecordStatus: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}