My MATRIXX REST APIs

My MATRIXX supports GET, PUT, and POST REST bindings. The { } notation around text represents a URL parameter.

The My MATRIXX REST bindings support the following URL paths:

/matrixx/data/objects/{type}/{flow}
/matrixx/objects/{type}/{flow}

The {type} can be any of the following:

Offer
Price
Matrix
Normalizer
ServiceType

The {flow} can be any of the following:

Offer, Price, Matrix: basic
Normalizer: basic, Apn, Ccd, IpMapping, RateTag, RestrictedIp, Zone
ServiceType: beats

Supported Operations

The examples in the documentation use /matrixx/data/objects/{type}/{flow}, but you can use either path in your REST calls.

GET /matrixx/data/objects/{type}/{flow}
Retrieves lists of objects. Returns the objects of the specified type and flow from the in-memory database.
GET /matrixx/data/objects/{type}/{flow}/{id}
Retrieves a single object. Returns an XML representation of the object from the in-memory database.
GET /matrixx/data/objects/{list type}/default
Queries the My MATRIXX domain and returns information about the objects. Use these GET operations to discover the current contents of a My MATRIXX domain.
PUT /matrixx/data/objects/{type}/{flow}/{id}
Updates an instance of a given type of object. For objects with revisions, this causes a new revision to be created.
Note: Out of the box, a PUT operation on a Normalizer object updates the object and does not create a new revision.
When an object is updated using a PUT call, the system creates a new revision of the current object and then updates that new revision with any of the information specified in the XML sent as the payload of the PUT call. Missing fields are ignored. For fields that contain lists of values, if the List is specified, then a new list is created and all entries passed in replace the list already in the object. List field names all end in List, and any field that does not end in List is not a list field. On success, a result document is returned to the caller. For example:
```
<UpdateResponse>
    <type>Normalizer</type>
    <Result>0</Result>
    <ResultText>Success</ResultText>
    <ObjectId>1066</ObjectId>
    <Revision>1</Revision>
</UpdateResponse>
```

POST matrixx/data/objects/{type}/{flow}

Create a new object and return its ID. You must include the complete XML. The response is similar to:

<CreateResponse>
    <type>Matrix</type>
    <Result>0</Result>
    <ResultText>Succeeded</ResultText>
    <ObjectId>42</ObjectId>
    <Revision>2</Revision>
</CreateResponse>

Basic REST Bindings

The Basic REST bindings support the following:

SKIP and error formulas
Attributes
Parameters
Data modify profiles
Metadata
In addition to the name attribute, GET calls can return the following information (depending on the rate table):
- advance_arrears
- applies_to
- default_data_modify_profile
- description
- eventTypeId
- exceed_credit_limit
- external_id
- rollover
- rollover_period
- scale_field
- scaleBalanceSlot
- scaleBasis