API Endpoint

Authentication

If calling the endpoint from a page hosted within CreataCRM the API Enpoint will use the currently authenticated user.

If you would like to make API calls from an external source the follow headers are required.

Read

URL: /DXX.axd?handlerName=ApiEndpointHttpHandler

HTTP Verb: Post

Example Request Body:

{
    Type: "Contact",
    Mappings: [
                {
                    "PropertyName": "Oid",
                    "Processor": "DirectValue",
                    "Options": {
                        "$type": "DBP_CRM.Module.Web.Handlers.Xaf.ClientPageApiHandler.Processors.DirectValueProcessorOptions, DBP_CRM.Module.Web",
                        "Field": "Oid"
                    }
                },
                    {
                    "PropertyName": "FirstName",
                    "Processor": "DirectValue",
                    "Options": {
                        "$type": "DBP_CRM.Module.Web.Handlers.Xaf.ClientPageApiHandler.Processors.DirectValueProcessorOptions, DBP_CRM.Module.Web",
                        "Field": "FirstName"
                    }
                }
    ]
}

Create

URL: /DXX.axd?handlerName=ApiEndpointHttpHandler

HTTP Verb: Post

Example Request Body:

{
    Type: "Contact",
    Mappings: [
                {
                    "PropertyName": "Oid",
                    "Processor": "DirectValue",
                    "Options": {
                        "$type": "DBP_CRM.Module.Web.Handlers.Xaf.ClientPageApiHandler.Processors.DirectValueProcessorOptions, DBP_CRM.Module.Web",
                        "Field": "Oid"
                    }
                },
                    {
                    "PropertyName": "FirstName",
                    "Processor": "DirectValue",
                    "Options": {
                        "$type": "DBP_CRM.Module.Web.Handlers.Xaf.ClientPageApiHandler.Processors.DirectValueProcessorOptions, DBP_CRM.Module.Web",
                        "Field": "FirstName"
                    }
                }
    ],
    Payload: {
        FirstName: "Matt"
    }
}

Update

URL: /DXX.axd?handlerName=ApiEndpointHttpHandler&key=8588bb9c-63fa-4fa6-8ba2-b0d46f99b337

HTTP Verb: PUT

Example Request Body:

{
    Type: "Contact",
    Mappings: [
                {
                    "PropertyName": "Oid",
                    "Processor": "DirectValue",
                    "Options": {
                        "$type": "DBP_CRM.Module.Web.Handlers.Xaf.ClientPageApiHandler.Processors.DirectValueProcessorOptions, DBP_CRM.Module.Web",
                        "Field": "Oid"
                    }
                },
                    {
                    "PropertyName": "FirstName",
                    "Processor": "DirectValue",
                    "Options": {
                        "$type": "DBP_CRM.Module.Web.Handlers.Xaf.ClientPageApiHandler.Processors.DirectValueProcessorOptions, DBP_CRM.Module.Web",
                        "Field": "FirstName"
                    }
                }
    ],
    Payload: {
        FirstName: "Matt"
    }
}

Delete

URL: /DXX.axd?handlerName=ApiEndpointHttpHandler&key=8588bb9c-63fa-4fa6-8ba2-b0d46f99b337

HTTP Verb: DELETE

Example Request Body:

{
    Type: "Contact",
}