API Fleet modify

Modify Fleet (PUT)

Modify the information of an existing fleet.

http://api2.carmd.com/v2.0/fleet

Request Data

Example


{

  "fleetID" : "54fd50633c108153ecafd561",

  "orgID" :"54ed94233c1081156ce39469",

  "name" : "Fleet ABC",

  "customID" :"Fleet ABC W.W",

  "email" :"lien.nguyen@carmd.com",

  "country": "USA"

}

Field	Type	Notes
fleetID	string	Required. The fleet to modify.
orgID	string	Optional. The orgID this fleet belongs under.
name	string	Optional. Label this fleet by user friendly name of your choice. May use the same name on multiple fleets.
customID	string	Optional. Label this fleet by customID of your choice. customID should be unique.
email	string	Optional. Contact email of the fleet admin.
country	string	Optional. Country this fleet is in.

Response

Example


{

    "message": {

        "code": 0,

        "message": "OK",

        "credentials": "Valid",

        "version": "v2.0.0",

        "account": "Free",

        "method": "Modify Fleet",

        "action": "PUT",

        "counter": 205

    },

    "data": {

        "fleetName": "Fleet ABC",

        "orgName": "ABC Organization",

        "email": "lien.nguyen@carmd.com",

        "fleetID": "54fd50633c108153ecafd561",

        "orgID": "54ed94233c1081156ce39469",

        "fleetCustomID": "Fleet ABC W.W",

        "country": "USA"

    }

}

Field	Type	Notes
message	Message
data	Fleet

Message object

Field	Type	Notes
code	string	Message code.
message	string	Ok or Failed.
credentials	string	Valid or Invalid.
version	string	v2.0.0
account	string	Free or Premium
method	string	Name of the API called
action	string	returns a GET, POST, PUT, DELETE
counter	integer	Counter for this request. Increments by one for every request made. This is only important for free users who have a limited number of API requests.

Fleet object

Field	Type	Notes
fleetname	string	User selected name for this fleet.
orgName	string	Name of the org this fleet belongs under.
email	string	Contact email of the fleet admin.
fleetID	string	CarMD’s generated ID for this fleet. This ID will always be unique to this fleet.
orgID	string	CarMD’s organization ID for this fleet.
fleetcustomID	string	Null or returns the customID of this fleet.
country	string	Null or the county this fleet is in.

essay helper online