Types - 4.0.0

Glossary

Here is the glossary of all terms that are used within this document.

Term	Abbreviation	Definition
Slug	Slug	A URL safe string used to identify an entity, usually generated by the name of the entity.

API Endpoints

deal-types
- Description: Use this service call to get information about deal type supported by FMTC.
- Example Request: https://s3.fmtc.co/api/4.0.0/deals-types?api_token=APIKEY
- For a full list of deal types, see Deal Types List - 4.0.0

deal-types

Request Parameters

Name	Value(s)	Description	Required	Default
api_token	APIKEY	API key for authentication, available on the API Keys & Calls page.(https://account.fmtc.co/cp/api_keys)	Yes	N/A, must always be provided
format	String XML, JSON, CSV, TAB, or PIPE	Choose the feed format you would like returned.	No	JSON
slug	String	Filter by deal type to only return the passed in deal type	Yes	N/A, must always be provided
id	Number	Filter by deal type ID within the slug	No	N/A, be default will return all deal types within the slug

Implementation

Response Elements

Name	Description
type	The human readable string of one of the deal type categories.
slug	The unique slug assigned to the type.
type_id	The FMTC ID of the deal type to be used in other FMTC endpoints.
name	The human readable name of the type.
full_slug	The entire slug name, including the type and the slug.

Example Response - JSON

Here is an example of a JSON Response from the deal-types endpoint.

CODE

{
  "type": "Content Type",
  "slug": "content-type",
  "type_id": 1,
  "name": "Discount/Incentive",
  "full_slug": "content-type-discount-incentive"
}

Example Response - XML

Here is an example of an XML Response from the deal-types endpoint.

CODE

<?xml version="1.0" encoding="iso-8859-1" ?>
<dealType>
  <type>Content Type</type>
  <slug>content-type</slug>
  <type_id>1</type_id>
  <name>Discount/Incentive</name>
  <full_slug>content-type-discount-incentive</full_slug>
</dealType>

Example Response - CSV

Here is an example of a CSV Response from the deal-types endpoint.

CODE

type,slug,type_id,name,full_slug
"Content Type","content-type",1,"Discount/Incentive","content-type-discount-incentive"

Example Response - TAB

Here is an example of a TAB Response from the deal-types endpoint.

CODE

type  slug  type_id name  full_slug
"Content Type"  "content-type"  1 "Discount/Incentive"  "content-type-discount-incentive"

Example Response - PIPE

Here is an example of a PIPE Response from the deal-types endpoint.

CODE

type|slug|type_id|name|full_slug
"Content Type"|"content-type"|1|"Discount/Incentive"|"content-type-discount-incentive"