AssignmentStatus

  • 15.5
This article is may not be up to date with the latest stable release of M4.

Description

The AssignmentStatus endpoint provides the API consumer with access to methods pertaining to the statuses available in M4 Assignment and related data objects. The endpoint allows consumers to retrieve specific statuses or pull all configured statuses.

Methods

URL base/Assignment/AssignmentStatus/Specification
Action GET
Description Returns a data dictionary that details the available web service methods related to the Assignment Status.
Parameters None
 Returns  A JSON object with method descriptions
Sample Return Object 
[
        {
            "HttpAction": "Get",
            "MethodName": "GetAssignmentWorkflowStatus",
            "Description": "Gets the customer service records for a single Assignment Workflow Status given the passed in ID value (see Path).",
            "Path": "/AssignmentStatus/GetAssignmentWorkflowStatus/32"
        }
]
URL base/Assignment/AssignmentStatus/GetAssignmentWorkflowStatus/ID
Action GET
Description Returns a Status object when given the ID of a valid Assignment Workflow Status in the M4 database.
Parameters
Name Required? Code Description
ID Yes Integer An integer value representing the ID of a Status in the M4 database.
Returns A JSON Assignment Workflow Status data object
Sample Return Object 
{
    "ID": 345,
    "Description": "Assignment Workflow Status Description",
    "BackColor": "BackColor",
    "ForeColor": "ForeColor",
    "ListOrder": null,
    "Default": null,
    "Visible": null,
    "ExecDIOnSuccess": null,
    "IsPending": false
    "IsCancelled": false
}
URL base/Assignment/AssignmentStatus/GetAssignmentWorkflowStatuses
Action GET
Description Returns a complete list of Status objects from the M4 database.
Returns A list of JSON Assignment Workflow Status data objects
Sample Return Object 
[
    {
        "ID": 345,
        "Description": "Assignment Status Description",
        "BackColor": "BackColor",
        "ForeColor": "ForeColor",
        "ListOrder": null,
        "Default": true,
        "Visible": false,
        "ExecDIOnSuccess": null,
        "IsPending": false
        "IsCancelled": false
    },
    {
        "ID": 678,
        "Description": "Assignment Workflow Description",
        "BackColor": "BackColor",
        "ForeColor": "ForeColor",
        "ListOrder": 1,
        "Default": null,
        "Visible": null,
        "ExecDIOnSuccess": false,
        "IsPending": false
        "IsCancelled": false
    },
    {
        "ID": 999,
        "Description": "Workflow Status Description",
        "BackColor": "BackColor",
        "ForeColor": "ForeColor",
        "ListOrder": 7,
        "Default": false,
        "Visible": true,
        "ExecDIOnSuccess": true,
        "IsPending": false
        "IsCancelled": false
    }
]
URL base/Assignment/AssignmentStatus/GetAssignmentStatusCode/ID
Action GET
Description Returns a Status object when given the ID of a valid Assignment Workflow Status Code in the M4 database.
Parameters
Name Required? Code Description
ID Yes Integer An integer value representing the ID of a Status Code in the M4 database.
Returns A JSON Assignment Workflow Status Code data object
Sample Return Object 
{
    "ID": 345,
    "Description": "Assignment Workflow Status Code Description",
    "StatValue": null,
    "RetainCustomerLink": false
}
URL base/Assignment/AssignmentStatus/GetAssignmentWorkflowStatusCodes
Action GET
Description Returns a complete list of Status Code objects from the M4 database.
Returns A list of JSON Assignment Workflow Status Code data objects
Sample Return Object 
[
    {
        "ID": 345,
        "Description": "Assignment Status Code Description",
        "StatValue": null,
        "RetainCustomerLink": false
    },
    {
        "ID": 678,
        "Description": "Assignment Workflow Code Description",
        "StatValue": 2,
        "RetainCustomerLink": false
    },
    {
        "ID": 999,
        "Description": "Workflow Status Code Description",
        "StatValue": null,
        "RetainCustomerLink": true
    }
]

Was this article helpful?

Yes No

Related Articles