/memberships

Mount Point: /api/memberships

POST

Creates a Membership based on the specified UIMembershipDTO

Request Body

element: membership
media types: */*
application/xml

DTO representation of the Membership to create

Response Body

element: (custom)
media types: */*
application/xml

Id of the task associated with creating the membership.

Status Codes

HTTP Status Code Description
202 Accepted Accepted - proposed
400 Bad Request Bad request - see returned ExceptionDTO
401 Unauthorized Authentication required.
403 Forbidden Authorization required - access forbidden

GET

Retrieves all Memberships

Parameters

name description type default
zoneIds - Optional list of zoneIds - if set only Memberships containing exactly these zones will be returned. If not set all Memberships will be returned query

Response Body

element: membership
media types: application/xml
application/json

List of UIMembershipDTO

Status Codes

HTTP Status Code Description
200 OK OK
404 Not Found Not found - see returned ExceptionDTO
400 Bad Request Bad request - see returned ExceptionDTO
401 Unauthorized Authentication required.
403 Forbidden Authorization required - access forbidden