Creates a new membership
post
/learn.rest/v1/memberships
Request
Supported Media Types
- application/json
Membership object that needs to be created.
Root Schema : MembershipRequest
Type:
Show Source
object
-
learnCenterId:
number(int32)
Minimum Value:
178409
Maximum Value:1.0E18
Example:178784
-
status:
string
Example:
approved
-
userId:
number
Minimum Value:
112867
Maximum Value:1.0E18
Example:112900
-
validFromDate(optional):
string(date-time)
Example:
2016-02-23T07:21:00-05:00
-
validUntilDate(optional):
string(date-time)
Example:
2016-02-23T07:21:00-05:00
Example:
{
"learnCenterId":178784,
"userId":112900,
"status":"approved",
"validFromDate":"2016-02-23T07:21:00-05:00",
"validUntilDate":"2016-02-23T07:21:00-05:00"
}
Security
-
auth: basic
Type:
basic
Description:Basic Authentication
Response
Supported Media Types
- application/json
201 Response
New membership resource created.
Root Schema : MembershipResponse
Type:
Show Source
object
-
createdDate(optional):
string
Example:
2016-02-23T07:21:00-05:00
-
id(optional):
number(int32)
Example:
1345
-
learnCenter(optional):
array learnCenter
-
learnCenterId(optional):
number(int32)
Minimum Value:
178409
Maximum Value:1.0E18
Example:178784
-
links(optional):
object MembershipLinkItems
-
status(optional):
string
Example:
approved
-
statusChangedByUser(optional):
array statusChangedByUser
-
statusChangedByUserId(optional):
string
Example:
135131
-
statusChangedDate(optional):
string
Example:
2016-02-23T07:21:00-05:00
-
user(optional):
array user
-
userId(optional):
number
Minimum Value:
112867
Maximum Value:1.0E18
Example:112900
-
validFromDate(optional):
string(date-time)
Example:
2016-02-23T07:21:00-05:00
-
validUntilDate(optional):
string(date-time)
Example:
2016-02-23T07:21:00-05:00
Example:
{
"statusChangedDate":"2016-02-23T07:21:00-05:00",
"statusChangedByUser":[
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/users/456"
},
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/users/456"
}
],
"validUntilDate":"2016-02-23T07:21:00-05:00",
"userId":112900,
"createdDate":"2016-02-23T07:21:00-05:00",
"learnCenter":[
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/learncenters/178784"
},
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/learncenters/178784"
}
],
"learnCenterId":178784,
"statusChangedByUserId":"135131",
"validFromDate":"2016-02-23T07:21:00-05:00",
"links":{
"rel":"canonical",
"href":"{url}/learn.rest/v1/memberships/456"
},
"id":1,
"user":[
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/users/456"
},
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/users/456"
}
],
"status":"approved"
}
Nested Schema : MembershipLinkItems
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/memberships/456
-
rel(optional):
string
Example:
canonical
Example:
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/memberships/456"
}
Nested Schema : LearnCenterLinkItem
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/learncenters/178784
-
rel(optional):
string
Example:
canonical
Example:
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/learncenters/178784"
}
Nested Schema : UserLinkItems
Type:
Show Source
object
-
href(optional):
string
Example:
{url}/learn.rest/v1/users/456
-
rel(optional):
string
Example:
canonical
Example:
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/users/456"
}
400 Response
Request has incorrect syntax or does not contain a field that is required.
409 Response
Another resource with the same identifier already exists.
500 Response
Internal server error.