Jasmin Developers - Web API Reference

Platform | Contact Type

Service to manage entities of type 'ContactType'.

Overview


URL api/{tenantKey}/{orgKey}/corePatterns/contactTypes
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET ContactTypes (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts (ODataQueryOptions) OData query option.

Response:

When successful, the response body contains the list of records available. See ContactTypeResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /corePatterns/contactTypes/odata

GET ContactType by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body contains the entity record. See ContactTypeResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /corePatterns/contactTypes/{id}

GET ContactType by key

Returns the entity record that matches the specified key.

The following elements are required:

contactTypeKey (string) The key for the contact type.

Response:

When successful, the response body contains the entity record. See ContactTypeResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /corePatterns/contactTypes/{contactTypeKey}

POST Operations

POST ContactTypes

Creates a new entity record.

The following elements are required:

contactTypeResource (ApiContactTypeResource) The request body should contain the entity record that should be created.
See ApiContactTypeResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiContactTypeResource.

Response status codes:

201 Created. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /corePatterns/contactTypes

PUT Operations

PUT Set ContactTypeKey ContactType

Updates the value of attribute 'ContactTypeKey' in the specified entity record.

The following elements are required:

contactTypeKey (string) The key for the contact type.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /corePatterns/contactTypes/{contactTypeKey}/contactTypeKey

PUT Set Description ContactType

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

contactTypeKey (string) The key for the contact type.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /corePatterns/contactTypes/{contactTypeKey}/description

PUT Set IsActive ContactType

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

contactTypeKey (string) The key for the contact type.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /corePatterns/contactTypes/{contactTypeKey}/isActive

DELETE Operations

DELETE ContactType by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /corePatterns/contactTypes/{id}

DELETE ContactType by key

Deletes the entity record that matches the specified key.

The following elements are required:

contactTypeKey (string) The key for the contact type.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /corePatterns/contactTypes/{contactTypeKey}

Resources


ApiContactTypeResource

The following elements are required:

contactTypeKey (string) The key for the contact type.
isMainContactType (bool) Is Main Contact Type.

The following elements are optional:

description (string) The description for the contact type.


ContactTypeResource

The following elements are required:

contactTypeKey (string) The key for the contact type.
isMainContactType (bool) Is Main Contact Type.

The following elements are optional:

description (string) The description for the contact type.