Platform API

<back to all web services

GetSupplierStatuses

Get supplier statuses for e.g New, Viewed, Accepted etc.

Requires Authentication
The following routes are available for this service:
All Verbs/api/lists/statuses/supplierstatus
GetListItemsResponse Parameters:
NameParameterData TypeRequiredDescription
ListItemsformList<ListItemModel>No
ResponseStatusformResponseStatusNo
ListItemModel Parameters:
NameParameterData TypeRequiredDescription
ListItemIdformGuidNo
NameformstringNo
DescriptionformstringNo
ShortNameformstringNo
IsDefaultformboolNo
OrderformintNo
ListItemTrafficLightIdformGuidNo
PrimaryListItemImageIdformGuidNo
PrimaryListItemImageUrlformstringNo
PrimaryImageThumbnailUrlformstringNo
OwnerContactIdformGuidNo
RecordStatusformstringNo

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/statuses/supplierstatus 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
		}
	}
}