Jump to

• Request
• Response

Get a membership.

get

/learn.rest/v1/memberships/{membershipId}

Request

Path Parameters

• membershipId: number
  Unique identifier of membership.

Security

• auth: basic
  Type: basic

  Description: Basic Authentication

Back to Top

Response

Supported Media Types

• application/json

200 Response

Membership fetched.

Body ()

Root Schema : MembershipResponse

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "format":"int32",
            "example":1345
        },
        "learnCenterId":{
            "type":"number",
            "format":"int32",
            "example":178784,
            "minimum":178409,
            "maximum":1.0E18
        },
        "learnCenter":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LearnCenterLinkItem"
            }
        },
        "userId":{
            "type":"number",
            "example":112900,
            "minimum":112867,
            "maximum":1.0E18
        },
        "user":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLinkItems"
            }
        },
        "createdDate":{
            "type":"string",
            "example":"2016-02-23T07:21:00-05:00"
        },
        "status":{
            "type":"string",
            "example":"approved"
        },
        "statusChangedDate":{
            "type":"string",
            "example":"2016-02-23T07:21:00-05:00"
        },
        "statusChangedByUserId":{
            "type":"string",
            "example":"135131"
        },
        "statusChangedByUser":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLinkItems"
            }
        },
        "validFromDate":{
            "type":"string",
            "format":"date-time",
            "example":"2016-02-23T07:21:00-05:00"
        },
        "validUntilDate":{
            "type":"string",
            "format":"date-time",
            "example":"2016-02-23T07:21:00-05:00"
        },
        "links":{
            "$ref":"#/definitions/MembershipLinkItems"
        }
    },
    "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"
    }
}

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 : learnCenter

Type: array

Show Source

• Array of: object LearnCenterLinkItem

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LearnCenterLinkItem"
    }
}

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

Show Source

• Array of: object UserLinkItems

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserLinkItems"
    }
}

Nested Schema : user

Type: array

Show Source

• Array of: object UserLinkItems

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserLinkItems"
    }
}

Nested Schema : LearnCenterLinkItem

Type: object

Show Source

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

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

Example:

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

Nested Schema : UserLinkItems

Type: object

Show Source

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

{
    "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"
}

401 Response

Authentication refused for provided credentials or the token is invalid.

Headers

• WWW_Authenticate: string

404 Response

Resource not found.

500 Response

Internal server error.

Back to Top