Contact Point Type

(API Version v3)

This entity represents the different ways in which a Contact can be communicated with. Examples are "email", "phone", "text" and "address".

What can you do with ContactPointType?

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

Properties

Property Details

identity READ-ONLY	"identity": 15 Type: Number This is the unique numeric identifier for the ContactPointType
name READ-ONLY	"name": "email" Type: String System defined name of the Contact Point Type
dataTypeId	"dataTypeId": 18 Type: Number Unique identifier for the associated DataType object.
dataTypeName	"dataTypeName": "Sample Name" Type: String The name of the object associated with the dataTypeId property.
isRequired READ-ONLY	"isRequired": true Type: Boolean Whether or not this type is required.
contactTypeId	"contactTypeId": 17 Type: Number Unique identifier for the associated ContactType object.
contactTypeName	"contactTypeName": "Sample Name" Type: String The name of the object associated with the contactTypeId property.
allowMultiple READ-ONLY	"allowMultiple": true Type: Boolean Whether or not multiple Contact Points of this type can be allowed for a Contact.
isCore READ-ONLY	"isCore": true Type: Boolean

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:

name
dataTypeId
isRequired
contactTypeId
allowMultiple
isCore

End Points

Retrieve all of the ContactPointType objects.

GET api/v3/ContactPointType/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "email",
            "dataTypeId": 25,
            "dataTypeName": "Sample Text Data",
            "isRequired": true,
            "contactTypeId": 9,
            "contactTypeName": "Sample Text Data",
            "allowMultiple": true,
            "isCore": true
        }
    ]
}

Retrieve all of the ContactPointType 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 ContactPointType objects in a paged fashion.

GET api/v3/ContactPointType/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,
                "name": "email",
                "dataTypeId": 22,
                "dataTypeName": "Sample Text Data",
                "isRequired": true,
                "contactTypeId": 10,
                "contactTypeName": "Sample Text Data",
                "allowMultiple": true,
                "isCore": true
            }
        ]
    }
}

GET	api/v3/ContactPointType/{id}
Retrieve an instance of the ContactPointType object by its ID.
{id}	Unique identifier for the ContactPointType object.
Retrieve an instance of the ContactPointType object by its ID. GET api/v3/ContactPointType/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "name": "email", "dataTypeId": 11, "dataTypeName": "Sample Text Data", "isRequired": true, "contactTypeId": 19, "contactTypeName": "Sample Text Data", "allowMultiple": true, "isCore": true } }