Syntch Gateway API

GetAllCustomFields

Administration - Custom Field Management

**Requires Authentication**
Requires the role:	Merchant

The following routes are available for this service:
GET	/customfields	Gets a collection of 'pending', 'active' and 'inactive' and possibly 'deleted' custom fields for the merchant requester.

**GetAllCustomFields** Parameters:
Name	Parameter	Data Type	Required	Description
IncludeDeleted	query	bool	No	Whether to include deleted records in the response, defaults to false.

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.

GET /customfields HTTP/1.1 
Host: syntch.simpay.net 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		Key: 0,
		Name: String,
		MerchantKey: 0,
		IsNumeric: False,
		DecimalPlaces: 0,
		RegularExpression: String,
		IsRequired: False,
		ActivationStatus: Pending,
		Description: String,
		ErrorMessage: String,
		MinValue: 0,
		MaxValue: 0,
		MaxLength: 0,
		Position: 0,
		DisplayOnVTReceipt: False,
		DisplayOnReports: False,
		DisplayOnHpp: False,
		ReadOnlyOnHpp: False,
		VisibleOnHpp: False
	}
]