Endpoint Methods

Describes a function that provides access to a data or service in a system.

Path Params
string
required
Body Params
string | null

The Name of data type nvarchar in the EndpointMethod table is a field that stores strings with a maximum length of 4000 characters for a wide range of characters including characters from non-Latin scripts. This field is useful for capturing data from names or titles which may include unique alphabets or symbols.

string | null

Value of the EndpointMethod table is a data type nvarchar, which stores variable-length, Unicode string data. It is used to represent a specific endpoint and retrieve data associated with that endpoint, such as name, address, code, and so forth. This field can store strings up to 4000 characters in length.

int32

EndpointId is an integer data type used to uniquely identify a row in the EndpointMethod table. It is the primary key column and can't be null.

string | null

The RequestTypeId field in the EndpointMethod table is an alphanumeric field with a maximum length of 450 characters that stores the unique identifier for the API request type.

string | null

The RequestMessageFormatId field in the EndpointMethod table contains a non-mandatory nvarchar of up to 64 characters which identifies the XML format of the request body sent to the endpoint. It is used to differentiate XML envelopes and/or SOAP standards that the endpoint may need to support.

string | null

The ResponseMessageFormatId field in the EndpointMethod table is a nvarchar field with a maximum length of 64. This field contains the ID of the response message format specified for the endpoint method.

string | null

Miscellaneous notes and information for the entry or record.

Response
200

OK

Language
URL
Response
Click Try It! to start a request and see the response here!