Versions Compared

Old Version 5

changes.mady.by.user Mickey Bushman

Saved on

compared with

New Version Current

changes.mady.by.user Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title3.0.0

The FlexAttribute API is used to create, update or delete flex attribute definitions. A flex attribute is a custom data input field that is used to collect additional information that was not originally designed into the mobile application.

Pushing Flex Attribute Updates to Mobile Devices

By default, calling the FlexAttribute API will not cause any updates to be used to the mobile devices. This is by design and is intended to allow for multiple updates (API calls) to be made before pushing out any changes. Updates will be pushed to the mobile device only when a GET request is made with the RefreshMobile URL parameter set to 1 as shown below.


Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel1

Related pages:


Resource URL Summary

Retrieve the details of a specific Flex Attribute

GET /seiapi/v3/trans/FlexAttribute/${FlexAttrID}

Insert a specific Flex Attribute

PUT /seiapi/v3/trans/FlexAttribute/${FlexAttrID}

Update a specific Flex Attribute

POST /seiapi/v3/trans/FlexAttribute/${FlexAttrID}

Push Flex Attribute changes to mobile device

GET /seiapi/v3/trans/FlexAttribute/${FlexAttrID}?RefreshMobile=1

Delete a specific Flex Attribute
Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid
DELETE  

/seiapi/v3/trans/FlexAttribute/${FlexAttrID}

API Specific Parameters

ParameterDescription

${FlexAttrID}

Identifies the unique flex attribute object.
RefreshMobile=1Add this parameter with a value of 1 to push updates to mobile devices.
Include Page_Default HTTP Headers_Default HTTP Headers

API Specifics

Panel

Retrieve the details of a specific Flex Attribute

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

GET /seiapi/v3/trans/FlexAttribute/${FlexAttrID}

HTTP Request Body

This request does not require a request body. 

HTTP Response Body

On success, an HTTP response code of 200 will be returned, and the response body will contain a REST Object Definitions Configuration Related Objects FlexAttr Object. Otherwise, on error, the response body will contain a descriptive reason for the error. 

Include Page_System Category Object Formats_System Category Object Formats
Panel

Insert a specific Flex Attribute

This REST API will insert a new Flex Attribute with the specified ID into the system, if a Flex Attribute with the specified ID does not already exist in the system. The system will return error in case Flex Attribute with specific ID exists.

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

PUT /seiapi/v3/trans/FlexAttribute/${FlexAttrID}

HTTP Request Body

The HTTP request body must contain a valid REST Object Definitions Configuration Related Objects FlexAttr Object.

HTTP Response

On success the API will return a response code of 200.

Panel

Update a specific Flex Attribute

This REST API will update a Flex Attribute with the specified ID in the system. The Flex Attribute with the specified ID must already exist in the system.

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

POST /seiapi/v3/trans/FlexAttribute/${FlexAttrID}

HTTP Request Body

The HTTP request body must contain a valid REST Object Definitions Configuration Related Objects FlexAttr Object.

HTTP Response

On success the API will return a response code of 200.

Panel

Push Flex Attribute changes to mobile device

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

GET /seiapi/v3/trans/FlexAttribute/${FlexAttrID}?RefreshMobile=1

HTTP Request Body

This request does not require a request body. 

HTTP Response

On success the API will return a response code of 200.

Panel

Delete a specific Flex Attribute

This REST API will delete a Flex Attribute with the specified ID from the system. The Flex Attribute with the specified ID must already exist in the system.

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

DELETE /seiapi/v3/trans/FlexAttribute/${FlexAttrID}

HTTP Request Body

This request does not require a request body. 

HTTP Response

On success the API will return a response code of 200.

Supported HTTP Methods

MethodDescription
GET

Returns the flex attribute definition identified by the ${FlexAttrID} URL parameter.

PUTCreates a new flex attribute definition identified by the ${FlexAttrID} URL parameter. If the flex attribute definition already exists and error will be returned.
POSTUpdates the existing flex attribute definition identified by the ${FlexAttrID} URL parameter.
DELETE

Deletes an existing flex attribute definition, identified by ${FlexAttrID} URL parameter. If the object does not exists or has been deleted, a soft warning is returned.

(info) A request body is not required for the DELETE method.

Include Page
_Default HTTP Headers
_Default HTTP Headers

HTTP Body

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

Include Page
_FlexAttr Object Formats
_FlexAttr Object Formats

Include Page
_REST Response Codes
_REST Response Codes