Skip to content

list-share

GET show

GET /list-share/{id}

Params

NameLocationTypeRequiredDescription
idpathstringyesnone

Response Examples

200 Response

{
"collectionId": "string",
"collectionName": "string",
"created": "2019-08-24T14:15:22Z",
"id": "string",
"permission": "view",
"list": "string",
"updated": "2019-08-24T14:15:22Z",
"user": "string"
}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKnoneInline
404Not FoundnoneInline

Responses Data Schema

HTTP Status Code 200

NameTypeRequiredRestrictionsTitledescription
» collectionIdstringtruenonenone
» collectionNamestringtruenonenone
» createdstring(date-time)truenonenone
» idstringtruenonenone
» permissionstringtruenonenone
» liststringtruenonenone
» updatedstring(date-time)truenonenone
» userstringtruenonenone

Enum

NameValue
permissionview
permissionedit

HTTP Status Code 404

NameTypeRequiredRestrictionsTitledescription
» urlstringtruenonenone
» statusintegertruenonenone
» responseobjecttruenonenone
»» codeintegertruenonenone
»» messagestringtruenonenone
»» dataobjecttruenonenone
» isAbortbooleantruenonenone
» originalErrorobjecttruenonenone
»» urlstringtruenonenone
»» statusintegertruenonenone
»» dataobjecttruenonenone
»»» codeintegertruenonenone
»»» messagestringtruenonenone
»»» dataobjecttruenonenone
» namestringtruenonenone

POST update

POST /list-share/{id}

Body Parameters

{
"list": "string",
"user": "string",
"permission": "view"
}

Params

NameLocationTypeRequiredDescription
idpathstringyesnone
Content-Typeheaderstringyesnone
bodybodyobjectnonone
» listbodystringyesnone
» userbodystringyesnone
» permissionbodystringyesnone

Enum

NameValue
» permissionview
» permissionedit

Response Examples

200 Response

{
"collectionId": "string",
"collectionName": "string",
"created": "2019-08-24T14:15:22Z",
"id": "string",
"permission": "view",
"list": "string",
"updated": "2019-08-24T14:15:22Z",
"user": "string"
}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKnoneInline
404Not FoundnoneInline

Responses Data Schema

HTTP Status Code 200

NameTypeRequiredRestrictionsTitledescription
» collectionIdstringtruenonenone
» collectionNamestringtruenonenone
» createdstring(date-time)truenonenone
» idstringtruenonenone
» permissionstringtruenonenone
» liststringtruenonenone
» updatedstring(date-time)truenonenone
» userstringtruenonenone

Enum

NameValue
permissionview
permissionedit

HTTP Status Code 404

NameTypeRequiredRestrictionsTitledescription
» urlstringtruenonenone
» statusintegertruenonenone
» responseobjecttruenonenone
»» codeintegertruenonenone
»» messagestringtruenonenone
»» dataobjecttruenonenone
» isAbortbooleantruenonenone
» originalErrorobjecttruenonenone
»» urlstringtruenonenone
»» statusintegertruenonenone
»» dataobjecttruenonenone
»»» codeintegertruenonenone
»»» messagestringtruenonenone
»»» dataobjecttruenonenone
» namestringtruenonenone

GET list

GET /list-share

Response Examples

200 Response

[
{
"collectionId": "string",
"collectionName": "string",
"created": "string",
"id": "string",
"list": "string",
"permission": "string",
"updated": "string",
"user": "string",
"expand": {
"user": {
"avatar": "string",
"collectionId": "string",
"collectionName": "string",
"id": "string",
"username": "string"
}
}
}
]

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKnoneInline

Responses Data Schema

HTTP Status Code 200

NameTypeRequiredRestrictionsTitledescription
» collectionIdstringfalsenonenone
» collectionNamestringfalsenonenone
» createdstringfalsenonenone
» idstringfalsenonenone
» liststringfalsenonenone
» permissionstringfalsenonenone
» updatedstringfalsenonenone
» userstringfalsenonenone
» expandobjectfalsenonenone
»» userobjecttruenonenone
»»» avatarstringtruenonenone
»»» collectionIdstringtruenonenone
»»» collectionNamestringtruenonenone
»»» idstringtruenonenone
»»» usernamestringtruenonenone

DELETE delete

DELETE /list-share/{id}

Params

NameLocationTypeRequiredDescription
idpathstringyesnone

Response Examples

200 Response

{
"acknowledged": true
}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKnoneInline
404Not FoundnoneInline

Responses Data Schema

HTTP Status Code 200

NameTypeRequiredRestrictionsTitledescription
» acknowledgedbooleantruenonenone

HTTP Status Code 404

NameTypeRequiredRestrictionsTitledescription
» urlstringtruenonenone
» statusintegertruenonenone
» responseobjecttruenonenone
»» codeintegertruenonenone
»» messagestringtruenonenone
»» dataobjecttruenonenone
» isAbortbooleantruenonenone
» originalErrorobjecttruenonenone
»» urlstringtruenonenone
»» statusintegertruenonenone
»» dataobjecttruenonenone
»»» codeintegertruenonenone
»»» messagestringtruenonenone
»»» dataobjecttruenonenone
» namestringtruenonenone

PUT create

PUT /list-share

Body Parameters

{
"list": "string",
"user": "string",
"permission": "view"
}

Params

NameLocationTypeRequiredDescription
bodybodyobjectnonone
» listbodystringyesnone
» userbodystringyesnone
» permissionbodystringyesnone

Enum

NameValue
» permissionview
» permissionedit

Response Examples

200 Response

{
"collectionId": "string",
"collectionName": "string",
"created": "2019-08-24T14:15:22Z",
"id": "string",
"permission": "view",
"list": "string",
"updated": "2019-08-24T14:15:22Z",
"user": "string"
}

Responses

HTTP Status CodeMeaningDescriptionData schema
200OKnoneInline
400Bad RequestnoneInline

Responses Data Schema

HTTP Status Code 200

NameTypeRequiredRestrictionsTitledescription
» collectionIdstringtruenonenone
» collectionNamestringtruenonenone
» createdstring(date-time)truenonenone
» idstringtruenonenone
» permissionstringtruenonenone
» liststringtruenonenone
» updatedstring(date-time)truenonenone
» userstringtruenonenone

Enum

NameValue
permissionview
permissionedit

HTTP Status Code 400

NameTypeRequiredRestrictionsTitledescription
» urlstringtruenonenone
» statusintegertruenonenone
» responseobjecttruenonenone
»» codeintegertruenonenone
»» messagestringtruenonenone
»» dataobjecttruenonenone
» isAbortbooleantruenonenone
» originalErrorobjecttruenonenone
»» urlstringtruenonenone
»» statusintegertruenonenone
»» dataobjecttruenonenone
»»» codeintegertruenonenone
»»» messagestringtruenonenone
»»» dataobjecttruenonenone
» namestringtruenonenone

Data Schema