State

(API Version v3)

What can you do with State?

GET api/v3/State/
Retrieve all of the State objects.
GET api/v3/State/Paged
Retrieve all of the State objects in a paged fashion.
GET api/v3/State/{id}
Retrieve an instance of the State object by its ID.

Properties

Property Details

identity READ-ONLY	"identity": 11 Type: Number This is the unique numeric identifier for the State
countryId	"countryId": 9 Type: Number Unique identifier for the associated Country object.
countryName	"countryName": "Sample Name" Type: String The name of the object associated with the countryId property.
name	"name": "Hello World" Type: String
sortOrder	"sortOrder": 23 Type: Number
code	"code": "Hello World" Type: String
isVisible	"isVisible": true Type: Boolean
ownerId READ-ONLY	"ownerId": 23 Type: Number Unique identifier for the associated Owner object.
ownerName READ-ONLY	"ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property.

Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

countryId
name
sortOrder
code
isVisible
countryCode

End Points

Retrieve all of the State objects.

GET api/v3/State/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "countryId": 24,
            "countryName": "Sample Text Data",
            "name": "Sample Text Data",
            "sortOrder": 9,
            "code": "Sample Text Data",
            "isVisible": true,
            "ownerId": 27,
            "ownerName": "Sample Text Data"
        }
    ]
}

Retrieve all of the State objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.

Retrieve all of the State objects in a paged fashion.

GET api/v3/State/Paged

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "countryId": 10,
                "countryName": "Sample Text Data",
                "name": "Sample Text Data",
                "sortOrder": 4,
                "code": "Sample Text Data",
                "isVisible": true,
                "ownerId": 1,
                "ownerName": "Sample Text Data"
            }
        ]
    }
}

GET	api/v3/State/{id}
Retrieve an instance of the State object by its ID.
{id}	Unique identifier for the State object.
Retrieve an instance of the State object by its ID. GET api/v3/State/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "countryId": 25, "countryName": "Sample Text Data", "name": "Sample Text Data", "sortOrder": 13, "code": "Sample Text Data", "isVisible": true, "ownerId": 19, "ownerName": "Sample Text Data" } }