| Requires any of the roles: | Agent, Administrator |
| GET | /v1/AutomatedAdjustment/type |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| AutomatedAdjustments | form | List<AutomatedAdjustment> | No | |
| AutomatedAdjustment | form | AutomatedAdjustment | No | |
| AutomatedAdjustmentID | form | int | No | |
| AutomatedAdjustmentTypes | form | List<AutomatedAdjustmentType> | No | |
| AutomatedAdjustmentFrequencies | form | List<AutomatedAdjustmentfrequency> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AutomatedAdustmentId | form | int | No | |
| Name | form | string | No | |
| FromAgentId | form | int | No | |
| ToAgentId | form | string | No | |
| ToAgentName | form | string | No | |
| Description | form | string | No | |
| TypeId | form | int | No | |
| TypeDescription | form | string | No | |
| FrequencyId | form | int | No | |
| FrequencyDescription | form | string | No | |
| Amount | form | decimal | No | |
| ChargeCount | form | int | No | |
| ChargeSum | form | decimal | No | |
| Installments | form | int | No | |
| PauseUntil | form | DateTime? | No | |
| DateCreated | form | DateTime | No | |
| CreatedBy | form | string | No | |
| ModifiedBy | form | string | No | |
| FirstCommissionRequired | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AutomatedAdjustmentTypeId | form | int | No | |
| Description | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AutomatedAdjustmentFrequencyId | form | int | No | |
| Description | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/AutomatedAdjustment/type HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
AutomatedAdjustments:
[
{
AutomatedAdustmentId: 0,
Name: String,
FromAgentId: 0,
ToAgentId: 0,
ToAgentName: String,
Description: String,
TypeId: 0,
TypeDescription: String,
FrequencyId: 0,
FrequencyDescription: String,
Amount: 0,
ChargeCount: 0,
ChargeSum: 0,
Installments: 0,
PauseUntil: 0001-01-01,
DateCreated: 0001-01-01,
CreatedBy: String,
ModifiedBy: String,
FirstCommissionRequired: False
}
],
AutomatedAdjustment:
{
AutomatedAdustmentId: 0,
Name: String,
FromAgentId: 0,
ToAgentId: 0,
ToAgentName: String,
Description: String,
TypeId: 0,
TypeDescription: String,
FrequencyId: 0,
FrequencyDescription: String,
Amount: 0,
ChargeCount: 0,
ChargeSum: 0,
Installments: 0,
PauseUntil: 0001-01-01,
DateCreated: 0001-01-01,
CreatedBy: String,
ModifiedBy: String,
FirstCommissionRequired: False
},
AutomatedAdjustmentID: 0,
AutomatedAdjustmentTypes:
[
{
AutomatedAdjustmentTypeId: 0,
Description: String
}
],
AutomatedAdjustmentFrequencies:
[
{
AutomatedAdjustmentFrequencyId: 0,
Description: String
}
]
}