Get Fleet (GET)

Retrieve a list of fleets based on filter criteria or look up a single fleet.

http://api2.carmd.com/v2.0/fleet?fleetID=fleetID1,fleetID2
http://api2.carmd.com/v2.0/fleet?orgID=orgID1,orgID2
http://api2.carmd.com/v2.0/fleet?name=name1,name2
http://api2.carmd.com/v2.0/fleet?customID=customID1,customID2
http://api2.carmd.com/v2.0/fleet?email=email1,email2
http://api2.carmd.com/v2.0/fleet?country=country1,country2

Example

http://api2.carmd.com/v2.0/fleet?fleetID=541655173c10813ac8a0f763
http://api2.carmd.com/v2.0/fleet?orgID=537c1d7f3c1081e3981b21e0
http://api2.carmd.com/v2.0/fleet?name=Joes%20Plumbing,Bobs%20Plumbing
http://api2.carmd.com/v2.0/fleet?customID=fleet-345,fleet-123
http://api2.carmd.com/v2.0/fleet?email=email1@gmail.com,email2@gmail.com
http://api2.carmd.com/v2.0/fleet?country=USA,CA

URL Parameters

Get by fleet ID

Field Type Notes
fleetID string Required. Separate by commas. ID of fleet to view. Including several IDs includes all fleet in the response.

Get by orgID

Field Type Notes
orgID string Required. Separate by commas. ID of organization. May return multiple fleets. Including several IDs includes all fleets in the response.

Get by user friendly name

Field Type Notes
name string Required. Separate by commas. Retrieve fleet by user friendly name. May return several fleets. Including several IDs includes all fleets in the response.

Get by customID

Field Type Notes
customID string Required. Separate by commas. Retrieve fleet by customID. Including several IDs includes all fleet in the response.

Get by email

Field Type Notes
email string Required. Separate by commas. Retrieve fleet by email. Including several IDs includes all fleet in the response.

Get by country

Field Type Notes
country string Required. Separate by commas. Retrieve fleet by country. Including several IDs includes all fleet in the response.

Response

Response:

{

    "message": {

        "code": 0,

        "message": "OK",

        "credentials": "Valid",

        "version": "v2.0.0",

        "account": "Free",

        "method": "Get Fleet List",

        "action": "GET",

        "counter": 200

    },

    "data": [

        {

            "fleetName": "Fleet -01 ",

            "orgName": "Makerting_001",

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

            "fleetID": "54dc22a43c108148a02908ce",

            "orgID": "54dc1d213c108148a02908bb",

            "fleetCustomId": "Fleet of mary",

            "country": null

        },

        {

            "fleetName": "Fleet -01 ",

            "orgName": "Makerting_001",

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

            "fleetID": "54dc22b53c108148a02908d1",

            "orgID": "54dc1d213c108148a02908bb",

            "fleetCustomId": "Fleet of mary ",

            "country": null

        }.....

    ],

    "pagination": {

        "pageSize": 2147483647,

        "currentPage": 1,

        "itemCount": 11,

        "totalPage": 1

    }

}
Field Type Notes
message Message
data list<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.

Fashioned homework-writer.com by culture makes so little use of his freedom, his free