Location

This resource allows you to fetch the location list.

You can search for any existing category using filters as defined here.

Pagination is supported for this resource. Click here to see the details of it.

You can retrieve the following information through this method.

Location ID
Location Description
Address line
City
State
Country
ZIP
Phone No.

GET

End Point: /locations

Sample response payload

CODE

[
  {
    "id": "string",
    "description": "string",
    "addressline": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "string",
    "phonenumber": "string"
  }
]

GET By ID

End Point: /locations/{ID}

Sample response payload

CODE

{
 "recordid": "string"
 "id": "string",
 "description": "string",
 "address":
           {
            "addressline": "string",
            "city": "string",
            "state": "string",
            "zip": "string",
            "country": "string"
           },
 "taxregion": "string",
 "phonenumber": "string",
 "udfs":
        [
         {
          "caption": "string",
          "value": "string"
         }
        ],
 "comments":
            [
             {
              "recordid": "string",
              "comment": "string",
              "alwaysontop": true,
              "createdbyid": "string",
              "createdbyname": "string",
              "createdbyfirstname": "string",
              "createdbymiddlename": "string",
              "createdbylastname": "string",
              "createddate": "MM/dd/yyyy HH:mm"
             }
            ],
 "rooms":
         [
          {
           "recordid": "string",
           "lineaction": [delete] //To delete a room
           "active": true,
           "description": "string",
           "roomnumber": "string",
           "parentroomnumber": "string",
           "length": 0,
           "width": 0,
           "ceilingheight": 0,
           "capacity": 0,
           "comments":
                      [
                       {
                        "recordid": "string",
                        "comment": "string",
                        "alwaysontop": true,
                        "createdbyid": "string",
                        "createdbyname": "string",
                        "createdbyfirstname": "string",
                        "createdbymiddlename": "string",
                        "createdbylastname": "string",
                        "createddate": "MM/dd/yyyy HH:mm"
                       }
                      ]
           }
          ]
}