Flex-Form REST API

Resource URL Summary

GET a list of all Flex-Form Definitions

GET /seiapi/v3/trans/FlexForm/

Manage A Specific Flex-Form Definition

GET /seiapi/v3/trans/FlexForm/${FlexFormID}

PUT /seiapi/v3/trans/FlexForm/${FlexFormID}

POST /seiapi/v3/trans/FlexForm/${FlexFormID}

DELETE /seiapi/v3/trans/FlexForm/${FlexFormID}

API Specific Parameters

Parameter	Description
`${FlexFormID}`	Identifies the unique form object.

Supported HTTP Methods

Method	Description
GET	Returns the FlexForm object identified by the `${FlexFormID}` URL parameter. If ${FlexFormID} is not specified then the entire list of available Flex-Forms is returned.
PUT	Creates a new FlexForm object identified by the `${FlexFormID}` URL parameter. If the FlexForm definition already exists and error will be returned.
POST	Updates the existing FlexForm object identified by the `${FlexFormID}` URL parameter.
DELETE	Deletes an existing FlexForm object, identified by `${FlexObjectID}` URL parameter. If the object does not exists or has been deleted, a soft warning is returned. A request body is not required for the DELETE method.

HTTP Headers
This API uses the default ServiceMobility HTTP Headers.

HTTP Body

The body contains a single FlexForm object in the format specified on the URL.

JSON Format

{
	"Desc": "",
	"FlexAttrRules": {
		"${FlexAttrID}": ""
	},
	"FlexFormID": "",
	"FlexGroups": [{
			"Title": {
				"en": "Group 1"
			},
			"FlexAttrs": [
				"100001"
			],
			"Rules": ""
		},
		{
			"Title": {
				"en": "Group 2"
			},
			"FlexAttrs": [
				"100002"
			],
			"Rules": ""
		},
		{
			"Title": {
				"en": "Group 3"
			},
			"FlexAttrs": [
				"100000"
			],
			"Rules": ""
		}
	],
	"Rules": "",
	"Title": {
		"en": "",
		"en-CA": ""
	}
}

HTTP Response

Response Codes

HTTP Code	Description
200	OK. Request was processed successfully. Even though the request may return a successful code of 200, the body may still contain warning details.
400	Syntax error in request. The response body will provide more details on the specific reason. Verify the URI, its parameters, and request body.
401	Unauthorized. The credentials are incorrect, please verify and try again.
404	Not Found. The URL is incorrect, please verify and try again.
405	The specified HTTP method is not supported for this resource.
409	Conflict. This error usually occurs when attempting to overwrite an existing object that can not be replaced.
410	The specified object does not exists. Please verify the URI.
500	An error has occurred within ServiceMobility. Please review the error message details and if necessary, contact customer support.

Response Body

{
    "code": 400,
    "detail": {
        "message": "",
        "params": {
            "value": ""
        },
        "dataPath": ""
    }
}

Response Object Properties

Property

Type

Description

code

integer

The HTTP response code.

detail

object

This object provides additional details the system provided while processing the transactions. Usually the details provide additional information on why an error occurred. However, it may also provide warning details even when the requests was successful. For example, the request may have returned a response of 200=OK, but included warnings in the response body of properties that are still being used that are marked for deprecation.

Property	Type	Description
message	string	A human readable message related to the processing of the request.
params	collection	A collection of additional key/value pairs that contain the values that caused the warning/error condition.
dataPath	string	Identifies the location within the request body the message refers to.