ROSEPEOPLE Developers - Web API Reference

People | Subscriber Type

Service to manage entities of type 'SubscriberType'.

Overview


URL api/{tenantKey}/{orgKey}/peopleCore/subscriberTypes
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 SubscriberTypes

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /peopleCore/subscriberTypes

GET SubscriberTypes (paged)

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

The following elements are optional:

page (int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

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

Response status codes:

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

Resource URL:

GET /peopleCore/subscriberTypes?page={page}&pageSize={pageSize}

GET SubscriberType 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 SubscriberTypeResource.

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 /peopleCore/subscriberTypes/{id}

GET SubscriberType by key

Returns the entity record that matches the specified key.

The following elements are required:

subscriberTypeKey (string) Subscriber Type.

Response:

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

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 /peopleCore/subscriberTypes/{subscriberTypeKey}

GET Print SubscriberType by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

GET /peopleCore/subscriberTypes/{id}/print?template={template}

GET Print SubscriberType by key

Prints the specified entity record.

The following elements are required:

subscriberTypeKey (string) Subscriber Type.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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 /peopleCore/subscriberTypes/{subscriberTypeKey}/print

GET Original Print SubscriberTypeOriginal by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

GET /peopleCore/subscriberTypes/{id}/printOriginal?template={template}

GET Original Print SubscriberType by key

Prints the specified entity record.

The following elements are required:

subscriberTypeKey (string) Subscriber Type.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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 /peopleCore/subscriberTypes/{subscriberTypeKey}/printOriginal

POST Operations

POST SubscriberTypes

Creates a new entity record.

The following elements are required:

subscriberTypeResource (ApiSubscriberTypeResource) The request body should contain the entity record that should be created.
See ApiSubscriberTypeResource.

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 ApiSubscriberTypeResource.

Response status codes:

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

Resource URL:

POST /peopleCore/subscriberTypes

PUT Operations

PUT Set IsActive SubscriberType

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

The following elements are required:

subscriberTypeKey (string) Subscriber 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 /peopleCore/subscriberTypes/{subscriberTypeKey}/isActive

PUT Set Name SubscriberType

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

The following elements are required:

subscriberTypeKey (string) Subscriber 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 /peopleCore/subscriberTypes/{subscriberTypeKey}/name

PUT Set SubscriberTypeKey SubscriberType

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

The following elements are required:

subscriberTypeKey (string) Subscriber 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 /peopleCore/subscriberTypes/{subscriberTypeKey}/subscriberTypeKey

PUT Set ValidationExpression SubscriberType

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

The following elements are required:

subscriberTypeKey (string) Subscriber 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 /peopleCore/subscriberTypes/{subscriberTypeKey}/validationExpression

DELETE Operations

DELETE SubscriberType 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 /peopleCore/subscriberTypes/{id}

DELETE SubscriberType by key

Deletes the entity record that matches the specified key.

The following elements are required:

subscriberTypeKey (string) Subscriber 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 /peopleCore/subscriberTypes/{subscriberTypeKey}

Resources


ApiSubscriberTypeResource

The following elements are required:

subscriberTypeKey (string) Subscriber Type.
name (string) Name.

The following elements are optional:

validationExpression (string) Validation Expression.


SubscriberTypeResource

The following elements are required:

subscriberTypeKey (string) Subscriber Type.
name (string) Name.

The following elements are optional:

validationExpression (string) Validation Expression.