Skip to main content

GET Sharing Type Options


The following table contains important information about the GET method in regards to receiving the sharing type options.

GET Sharing Type Options
URL or Endpoint/api/projects/projectId/players/options/sharing-type
BodyNot Applicable

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter NameprojectId
DescriptionUnique Id of the project.

Request Body

The request does not contain a request body


"success": true,
"errors": [],
"messages": [],
"result": [
"id": 1,
"name": "Page URL",
"value": "URL"
"id": 2,
"name": "Page URL & IFrame",
"value": "URL&IFrame"
"resultInfo": null,
"statusCode": 200

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
idinteger($int32)The id of the sharing type.
namestringThe name of the sharing type.
valuestringThe value of the sharing type.
resultInfostringReturns extra information about the result.
statusCodeinteger($int32)Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.


For information about the errors that are common to all actions, see Common Errors:

  • HTTP Status Code 400: Bad Request

  • HTTP Status Code 401: Unauthorized

  • HTTP Status Code 403: Forbidden

  • HTTP Status Code 404: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed