What API do I use do Route Assignment?

API Endpoint: v1/api/integration/routeassignment

Method: POST

Request Format: JSON structure

Example JSON structure:

Assign primary, sconday and alternate pumpers to a route

JSON

{
  "routename": "Route 1",
  "primaryusername": "abc@xyz.com",
  "secondaryusername": "abc_2@xyz.com",
  "alternateusernames": [
    "abc_4@xyz.com",
    "abc_5@xyz.com"
  ]
}

Response:

JSON

{
    "success": true,
    "message": "Success",
    "numProcessedItems": 1,
    "numUnProcessedItems": 0,
    "secondaryErrors": [],
    "output": {
        "processedItems": [
            {
                "record": {
                    "routename": "Route 1",
                    "routeid": 83163,
                    "primaryuserid": 66170,
                    "secondaryuserid": 66180,
                    "alternateuserids": [
                        66162,
                        66173
                    ]
                },
                "message": "route assignment successful"
            }
        ],
        "unProcessedItems": []
    }
}

Assign Primary and Alternate pumpers to a Route:

JSON

{
  "routename": "Route 1",
  "primaryusername": "abc@xyz.com",
  "secondaryusername": null,
  "alternateusernames": [
    "abc_2@xyz.com",
    "abc_3@xyz.com"
  ]
}

Response:

JSON

{
    "success": true,
    "message": "Success",
    "numProcessedItems": 1,
    "numUnProcessedItems": 0,
    "secondaryErrors": [],
    "output": {
        "processedItems": [
            {
                "record": {
                    "routename": "Route 1",
                    "routeid": 83163,
                    "primaryuserid": 66170,
                    "secondaryuserid": null,
                    "alternateuserids": [
                        66162,
                        66163
                    ]
                },
                "message": "route assignment successful"
            }
        ],
        "unProcessedItems": []
    }
}

Assign alternate pumpers to a Route

JSON

{
  "routename": "Route 1",
  "primaryusername": null,
  "secondaryusername": null,
  "alternateusernames": [
    "abc@xyz.com",
    "abc_5@xyz.com"
  ]
}

Response:

JSON

{
    "success": true,
    "message": "Success",
    "numProcessedItems": 1,
    "numUnProcessedItems": 0,
    "secondaryErrors": [],
    "output": {
        "processedItems": [
            {
                "record": {
                    "routename": "Route 1",
                    "routeid": 83163,
                    "primaryuserid": null,
                    "secondaryuserid": null,
                    "alternateuserids": [
                        66162,
                        66170
                    ]
                },
                "message": "route assignment successful"
            }
        ],
        "unProcessedItems": []
    }
}

Mandatory Fields:

Attributes

Attribute Key

Constraints

Route Name

routename

routename is required while route assignment

Primary Pumper

or

Secondary Pumper

or

Alternate Pumper

primaryusername

secondaryusername

alternateusernames

anyone of the attribute is required