Jump to

• Request
• Response

Creates a new membership

post

/learn.rest/v1/memberships

Request

Supported Media Types

• application/json

Body ()

Membership object that needs to be created.

Root Schema : MembershipRequest

Type: object

Membership request object. This object comprises all the parameters required to create a new membership.

Show Source

• learnCenterId: number(int32)
  Minimum Value: 178409

  Maximum Value: 1.0E18

  Unique identifier for the LearnCenter.

  Example: 178784
• status: string
  Status of the membership.

  Example: approved
• userId: number
  Minimum Value: 112867

  Maximum Value: 1.0E18

  User ID of the user being added to the membership.

  Example: 112900
• validFromDate(optional): string(date-time)
  The date the membership is valid from.

  Example: 2016-02-23T07:21:00-05:00
• validUntilDate(optional): string(date-time)
  The date the membership is valid until.

  Example: 2016-02-23T07:21:00-05:00

{
    "type":"object",
    "description":"Membership request object. This object comprises all the parameters required to create a new membership.",
    "required":[
        "learnCenterId",
        "status",
        "userId"
    ],
    "properties":{
        "learnCenterId":{
            "description":"Unique identifier for the LearnCenter.",
            "type":"number",
            "format":"int32",
            "example":178784,
            "minimum":178409,
            "maximum":1.0E18
        },
        "userId":{
            "description":"User ID of the user being added to the membership.",
            "type":"number",
            "example":112900,
            "minimum":112867,
            "maximum":1.0E18
        },
        "status":{
            "type":"string",
            "example":"approved",
            "description":"Status of the membership."
        },
        "validFromDate":{
            "type":"string",
            "format":"date-time",
            "example":"2016-02-23T07:21:00-05:00",
            "description":"The date the membership is valid from."
        },
        "validUntilDate":{
            "type":"string",
            "format":"date-time",
            "example":"2016-02-23T07:21:00-05:00",
            "description":"The date the membership is valid until."
        }
    },
    "example":{
        "learnCenterId":178784,
        "userId":112900,
        "status":"approved",
        "validFromDate":"2016-02-23T07:21:00-05:00",
        "validUntilDate":"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

Back to Top

Response

Supported Media Types

• application/json

201 Response

New membership resource created.

Body ()

Root Schema : MembershipResponse

Type: object

The Membership response object.

Show Source

• createdDate(optional): string
  Date the membership was created.

  Example: 2016-02-23T07:21:00-05:00
• id(optional): number(int32)
  Id of the membership.

  Example: 1345
• learnCenter(optional): array learnCenter
  Link to the LearnCenter items.
• learnCenterId(optional): number(int32)
  Minimum Value: 178409

  Maximum Value: 1.0E18

  Unique identifier of the Learn Center.

  Example: 178784
• links(optional): object MembershipLinkItems
• status(optional): string
  Status of the membership.

  Example: approved
• statusChangedByUser(optional): array statusChangedByUser
  The link to the user who changed the status.
• statusChangedByUserId(optional): string
  User Id of the user who changed the membership status.

  Example: 135131
• statusChangedDate(optional): string
  The date the status of the membership was changed.

  Example: 2016-02-23T07:21:00-05:00
• user(optional): array user
  Link to the users.
• userId(optional): number
  Minimum Value: 112867

  Maximum Value: 1.0E18

  Unique Identifier for the user.

  Example: 112900
• validFromDate(optional): string(date-time)
  The date from which the membership is valid.

  Example: 2016-02-23T07:21:00-05:00
• validUntilDate(optional): string(date-time)
  The date until which the membership is valid.

  Example: 2016-02-23T07:21:00-05:00

{
    "type":"object",
    "description":"The Membership response object.",
    "properties":{
        "id":{
            "type":"number",
            "format":"int32",
            "example":1345,
            "description":"Id of the membership."
        },
        "learnCenterId":{
            "type":"number",
            "format":"int32",
            "example":178784,
            "minimum":178409,
            "maximum":1.0E18,
            "description":"Unique identifier of the Learn Center."
        },
        "learnCenter":{
            "description":"Link to the LearnCenter items.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/LearnCenterLinkItems"
            }
        },
        "userId":{
            "type":"number",
            "example":112900,
            "minimum":112867,
            "maximum":1.0E18,
            "description":"Unique Identifier for the user."
        },
        "user":{
            "description":"Link to the users.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLinkItems"
            }
        },
        "createdDate":{
            "type":"string",
            "example":"2016-02-23T07:21:00-05:00",
            "description":"Date the membership was created."
        },
        "status":{
            "type":"string",
            "example":"approved",
            "description":"Status of the membership."
        },
        "statusChangedDate":{
            "type":"string",
            "example":"2016-02-23T07:21:00-05:00",
            "description":"The date the status of the membership was changed."
        },
        "statusChangedByUserId":{
            "type":"string",
            "example":"135131",
            "description":"User Id of the user who changed the membership status."
        },
        "statusChangedByUser":{
            "description":"The link to the user who changed the status.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLinkItems"
            }
        },
        "validFromDate":{
            "description":"The date from which the membership is valid. ",
            "type":"string",
            "format":"date-time",
            "example":"2016-02-23T07:21:00-05:00"
        },
        "validUntilDate":{
            "description":"The date until which the membership is valid.",
            "type":"string",
            "format":"date-time",
            "example":"2016-02-23T07:21:00-05:00"
        },
        "links":{
            "$ref":"#/definitions/MembershipLinkItems"
        }
    },
    "example":{
        "id":1,
        "learnCenterId":178784,
        "learnCenter":[
            {
                "rel":"canonical",
                "href":"{url}/learn.rest/v1/learncenters/123456"
            },
            {
                "rel":"canonical",
                "href":"{url}/learn.rest/v1/learncenters/123456"
            }
        ],
        "userId":112900,
        "user":[
            {
                "rel":"canonical",
                "href":"{url}/learn.rest/v1/users/456"
            },
            {
                "rel":"canonical",
                "href":"{url}/learn.rest/v1/users/456"
            }
        ],
        "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",
        "createdDate":"2016-02-23T07:21:00-05:00",
        "statusChangedByUserId":"135131",
        "validFromDate":"2016-02-23T07:21:00-05:00",
        "links":{
            "rel":"canonical",
            "href":"{url}/learn.rest/v1/memberships/456"
        },
        "status":"approved"
    }
}

Example:

{
    "id":1,
    "learnCenterId":178784,
    "learnCenter":[
        {
            "rel":"canonical",
            "href":"{url}/learn.rest/v1/learncenters/123456"
        },
        {
            "rel":"canonical",
            "href":"{url}/learn.rest/v1/learncenters/123456"
        }
    ],
    "userId":112900,
    "user":[
        {
            "rel":"canonical",
            "href":"{url}/learn.rest/v1/users/456"
        },
        {
            "rel":"canonical",
            "href":"{url}/learn.rest/v1/users/456"
        }
    ],
    "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",
    "createdDate":"2016-02-23T07:21:00-05:00",
    "statusChangedByUserId":"135131",
    "validFromDate":"2016-02-23T07:21:00-05:00",
    "links":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/memberships/456"
    },
    "status":"approved"
}

Nested Schema : learnCenter

Type: array

Link to the LearnCenter items.

Show Source

• Array of: object LearnCenterLinkItems
  Learn Center Link Item object. This object comprises links to the Learn Center Items.

{
    "description":"Link to the LearnCenter items.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/LearnCenterLinkItems"
    }
}

Nested Schema : MembershipLinkItems

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/memberships/456
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/memberships/456"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/memberships/456"
    }
}

Example:

{
    "rel":"canonical",
    "href":"{url}/learn.rest/v1/memberships/456"
}

Nested Schema : statusChangedByUser

Type: array

The link to the user who changed the status.

Show Source

• Array of: object UserLinkItems
  Object comprising user links.

{
    "description":"The link to the user who changed the status.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserLinkItems"
    }
}

Nested Schema : user

Type: array

Link to the users.

Show Source

• Array of: object UserLinkItems
  Object comprising user links.

{
    "description":"Link to the users.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserLinkItems"
    }
}

Nested Schema : LearnCenterLinkItems

Type: object

Learn Center Link Item object. This object comprises links to the Learn Center Items.

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/learncenters/123456
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "description":"Learn Center Link Item object. This object comprises links to the Learn Center Items.",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learncenters/123456"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/learncenters/123456"
    }
}

Example:

{
    "rel":"canonical",
    "href":"{url}/learn.rest/v1/learncenters/123456"
}

Nested Schema : UserLinkItems

Type: object

Object comprising user links.

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/users/456
• rel(optional): string
  Example: canonical

{
    "description":"Object comprising user links.",
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/users/456"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/users/456"
    }
}

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.

Back to Top