TAG LINE
SMALL TITLE

Country / Address Format

(API Version v3)


This internal entity contains properties regarding address formats for country definitions. Allows you to specify if a country has states/provinces or not.


What can you do with CountryAddressFormat?


Properties

Property Details
identity
READ-ONLY
"identity": 12
Type: Number
This is the unique numeric identifier for the CountryAddressFormat
ownerId
READ-ONLY
"ownerId": 27
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.
name
READ-ONLY
"name": "States and Provinces"
Type: String
System name of the address format
isStateRequired
READ-ONLY
"isStateRequired": true
Type: Boolean
Whether or not states must be defined for this address format.
isStateVisible
READ-ONLY
"isStateVisible": true
Type: Boolean
Whether or not the state information is shown on an address.
isCityRequired
READ-ONLY
"isCityRequired": true
Type: Boolean
Whether or not a city must be defined for this address format.
isCityVisible
READ-ONLY
"isCityVisible": true
Type: Boolean
Whether or not the city information is shown on an address.
isAddress2Visible
READ-ONLY
"isAddress2Visible": true
Type: Boolean
Whether or not the second line of address information is shown on an address.
isZipCodeRequired
READ-ONLY
"isZipCodeRequired": true
Type: Boolean
Whether or not a zipcode must be defined for this address format.
isZipCodeVisible
READ-ONLY
"isZipCodeVisible": true
Type: Boolean
Whether or not the zipcode information is shown on an address.


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:

  • identity
  • name
  • isStateRequired
  • isStateVisible
  • isCityRequired
  • isCityVisible
  • isAddress2Visible
  • isZipCodeRequired
  • isZipCodeVisible

End Points

DELETEapi/v3/Country/AddressFormat/{id}
Delete an instance of the CountryAddressFormat object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the CountryAddressFormat object.
Delete an instance of the CountryAddressFormat object.
DELETE api/v3/Country/AddressFormat/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "countryAddressFormat"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v3/Country/AddressFormat/
Retrieve all of the CountryAddressFormat objects.
Retrieve all of the CountryAddressFormat objects.
GET api/v3/Country/AddressFormat/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 15,
            "ownerName": "Sample Text Data",
            "name": "States and Provinces",
            "isStateRequired": true,
            "isStateVisible": true,
            "isCityRequired": true,
            "isCityVisible": true,
            "isAddress2Visible": true,
            "isZipCodeRequired": true,
            "isZipCodeVisible": true
        }
    ]
}
GETapi/v3/Country/AddressFormat/Paged
Retrieve all of the CountryAddressFormat 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 CountryAddressFormat objects in a paged fashion.
GET api/v3/Country/AddressFormat/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,
                "ownerId": 12,
                "ownerName": "Sample Text Data",
                "name": "States and Provinces",
                "isStateRequired": true,
                "isStateVisible": true,
                "isCityRequired": true,
                "isCityVisible": true,
                "isAddress2Visible": true,
                "isZipCodeRequired": true,
                "isZipCodeVisible": true
            }
        ]
    }
}
GETapi/v3/Country/AddressFormat/{id}
Retrieve an instance of the CountryAddressFormat object by its ID.
{id}Unique identifier for the CountryAddressFormat object.
Retrieve an instance of the CountryAddressFormat object by its ID.
GET api/v3/Country/AddressFormat/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 19,
        "ownerName": "Sample Text Data",
        "name": "States and Provinces",
        "isStateRequired": true,
        "isStateVisible": true,
        "isCityRequired": true,
        "isCityVisible": true,
        "isAddress2Visible": true,
        "isZipCodeRequired": true,
        "isZipCodeVisible": true
    }
}
POSTapi/v3/Country/AddressFormat/
Create a new instance of the CountryAddressFormat object.
Create a new instance of the CountryAddressFormat object.
POST api/v3/Country/AddressFormat/

{}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 6,
                "ownerName": "Sample Text Data",
                "name": "States and Provinces",
                "isStateRequired": true,
                "isStateVisible": true,
                "isCityRequired": true,
                "isCityVisible": true,
                "isAddress2Visible": true,
                "isZipCodeRequired": true,
                "isZipCodeVisible": true
            }
        ]
    }
}
PUTapi/v3/Country/AddressFormat/{id}
Update an existing instance of the CountryAddressFormat object.
Update an existing instance of the CountryAddressFormat object.
PUT api/v3/Country/AddressFormat/{id}

{
    "identity": 1
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 14,
                "ownerName": "Sample Text Data",
                "name": "States and Provinces",
                "isStateRequired": true,
                "isStateVisible": true,
                "isCityRequired": true,
                "isCityVisible": true,
                "isAddress2Visible": true,
                "isZipCodeRequired": true,
                "isZipCodeVisible": true
            }
        ]
    }
}