Description

This endpoint must be used for getting a profile by id ({id}) 

This endpoint must be consumed in GET request


Request


As part of the request headers, a Basic Auth must be sent:

Postman Auth Bearer token example



This must be sended in the Http headers of the request, look at the next curl example for a better understanding

Copy codecurl --location 'host:port/zynchro.api.system-config/v1/profiles/33?transaction_id=123456' \
--header 'Authorization: Bearer ••••••'


In java it would be something like this (depending on the dependency you use)

Copy codeOkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("host:port/zynchro.api.system-config/v1/profiles/33?transaction_id=123456")
  .method("GET", body)
  .addHeader("Authorization", "••••••")
  .build();
Response response = client.newCall(request).execute();


Next are listed the params required in the request


Field
SubField
Type
Description
IsRequired
transaction_id

text

A custom value to identify the data related to the request in the response (you can see the transactionId in the response header).


Example:

  • REQ000001

Note: This field is not related with the data to be retrieved, must be used by the client app in order to identify the request/response (if that is useful), the same value can be sended in multiple request (it’s not validated that the same value was sended before)


N


Consuming Service


Example Request

Consuming service 

(GET) URL:HOST:PORT/zynchro.api.system-config/v1/profiles/1?transaction_id=12233445666

Request Params:

  • transaction_id=123456


Response


Response 200 OK

If the params present in the request are valid, then you will receive a response 200 "ok" message code look at the next example:

Copy code{
    "header": {
        "resultCode": "ok",
        "messageCode": "ok",
        "messageDescription": "request ok",
        "transactionId": "123456"
    },
    "data": {
        "id": 33,
        "name": "UK Content Publisher TEST 6/17",
        "isDashboard": false,
        "isMap": true,
        "isList": 1,
        "isSnapshotMosaic": false,
        "isPlayerHealth": true,
        "isOperationalHealth": false,
        "isLocationCompliance": true,
        "isBandWidth": false,
        "isVDAMonitoring": true,
        "isVDAHealth": false,
        "isDashboardAnalytics": true,
        "isPlaybacks": false,
        "isEvents": true,
        "isPageViews": false,
        "isSessions": true,
        "isDownloadFTP": false,
        "isManageLocations": true,
        "isUpdateLocation": false,
        "isGroupsLocation": true,
        "isPlayersLocation": false,
        "isSmartGroups": true,
        "isTags": false,
        "isMediaLibrary": true,
        "isFilesLibrary": false,
        "isMediaFeed": true,
        "isPresentations": false,
        "isAuthorizeContent": true,
        "isPublishLocation": false,
        "isPublishLocationGroup": true,
        "isPublishSmartGroups": false,
        "isPublishUpdatePresentation": true,
        "isPublishUpdatePlaylist": false,
        "isPublishFirmware": true,
        "isPublishLog": false,
        "isWall": true,
        "isContentLog": false,
        "cmCampaigns": 2,
        "cmCanApprove": true,
        "cmRundown": false,
        "cmDayparting": false,
        "cmBanners": false,
        "cmProManufacturer": true,
        "cmProBrands": false,
        "cmProCategories": false,
        "cmProRevenueClass": false,
        "cmProFillers": true,
        "cmProInserts": false,
        "cmProPresentations": false,
        "cmProSettings": false,
        "cmProReports": true,
        "cmProInventory": false,
        "cmInventory": 2,
        "cmProDisclaimer": false,
        "cmReports": 1,
        "isTVControl": false,
        "isDownloadControl": true,
        "isRemoteSetup": false,
        "isBDeploy": true,
        "isPlayerSetup": false,
        "isSmartActions": true,
        "isStocks": false,
        "isLicenses": true,
        "isUsers": false,
        "isSetupUser": true,
        "isPlayListStandard": false,
        "isDayparting": true,
        "isAdminClients": false,
        "clients": null
    }
}


Description of the response data

Field
SubField
Type
Description

header

 

Object

Specific data related to the response

 

resultCode

text

The result code of the response, can be:

·         error -> if errors were found

·         ok -> if NO errors were found

 

messageCode

text

The message code related to the result code of the response, can be:

Example:

 

 

messageDescription

text

The description of the message code

Example:

·         request ok

·         Please check your params fields

 

transactionId

text

The transactionId specified in the request, if no transactionId was sended in the request then the transacionId in the response will be null

errors

 

Array

 This field is present if there are errors in the request

 

fieldName

text

The field with errors

 

fieldDesc

text

 The description of the error

Data

 

Array

The specific response data related to the request


id

int

The identifier of the profile

Example: 1


name

text

The name of the profile


isDashboard

boolean

Used to access data in:

  • Monitoring menu, 
    • Dashboard submenu


isMap

boolean

Used to access data in: 

  • Monitoring menu, 
    • By Map submenu


isList

int

Used to access data in: 

  • Monitoring menu, 
    • By List submenu
    • By Filters submenu
    • Download Manager submenu

These are the possible values this field can retrieve:

  • 0 -> the module cannot be accessed 
  • 1 -> allows access to the module, the user can't modify the content 
  • 2 -> Allows access to the module, the user can modify the content


isSnapshotMosaic

boolean

Used to access data in:

  • Monitoring menu, 
    • Snapshot Mosaic submenu


isPlayerHealth

boolean

Used to access data in:

  • Monitoring menu, 
    • Player Health submenu


isOperationalHealth

boolean

Used to access data in:

  • Monitoring menu, 
    • Operational Health submenu


isLocationCompliance

boolean

Used to access data in:

  • Monitoring menu, 
    • Location Compliance submenu


isBandWidth

boolean

Used to access data in:

  • Monitoring menu, 
    • Bandwidth submenu


isVDAMonitoring

boolean

Used to access data in:

  • VDA menu, 
    • Monitoring submenu


isVDAHealth

boolean

Used to access data in:

  • VDA menu, 
    • Health submenu


isDashboardAnalytics

boolean

Used to access data in:

  • Analytics menu 
    • Dashboard submenu


isPlaybacks

boolean

Used to access data in:

  • Analytics menu 
    • Playbacks submenu


isEvents

boolean

Used to access data in:

  • Analytics menu 
    • Events submenu


isPageViews

boolean

Used to access data in:

  • Analytics menu 
    • PageViews submenu


isSessions

boolean

Used to access data in: 

  • Analytics menu 
    • Sessions submenu


isDownloadFTP

boolean

Used to access data in: 

  • Analytics menu 
    • FTP submenu


isManageLocations

boolean

Used to access data in:

  • Locations menu 
    • List submenu


isUpdateLocation

boolean

Used to access data in: 

  • Locations menu 
    • Uploadsubmenu


isGroupsLocation

boolean

Used to access data in: 

  • Locations menu 
    • Player Set submenu


isPlayersLocation

boolean

Used to access data in:

  • Groups menu 
    • By Location submenu


isSmartGroups

boolean

Used to access data in:

  • Groups menu 
    • Smart Groups submenu


isTags

boolean

Used to access data in:

  • Content menu 
    • Tags submenu


isMediaLibrary

boolean

Used to access data in:

  • Content menu 
    • Media Library submenu


isFilesLibrary

boolean

Used to access data in:

  • Content menu 
    • Files Library submenu


isMediaFeed

boolean

Used to access data in:

  • Content menu 
    • Media Feed submenu


isPresentations

boolean

Used to access data in:

  • Content menu 
    • Presentations submenu


isAuthorizeContent

boolean

Used to access data in:

  • Content menu 
    • Authorize Content submenu


isPublishLocation

boolean

Used to access data in:

  • Content menu 
    • Publish submenu
      • Location Tab


isPublishLocationGroup

boolean

Used to access data in:

  • Content menu 
    • Publish submenu
      • Location Group Tab


isPublishSmartGroups

boolean

Used to access data in:

  • Content menu 
    • Publish submenu
      • Smart Group Tab


isPublishUpdatePresentation

boolean

Used to access data in:

  • Content menu 
    • Publish submenu
      • Update Presentation Tab


isPublishUpdatePlaylist

boolean

Used to access data in: 

  • Content menu 
    • Publish submenu
      • Update Publish Tab


isPublishFirmware

boolean

Used to access data in:

  • Content menu 
    • Publish submenu
      • Firmware Tab


isPublishLog

boolean

Used to access data in:

  • Content menu 
    • Programming Log submenu


isWall

boolean

Used to access data in: 

  • Content menu 
    • Wall submenu


isContentLog

boolean

Used to access data in:

  • Content menu 
    • Activity Log submenu


cmCampaigns

int

Used to access data in:

  • Campaign Manager menu 
    • Campaign submenu


cmCanApprove

boolean

It is used to change a status campaign to approved


cmRundown

boolean

Used to access data in:

  • Campaign Manager menu 
    • Rundown submenu


cmDayparting

boolean

Used to access data in:

  • Campaign Manager menu 
    • Takeover submenu


cmBanners

boolean

Used to access data in:

  • Campaign Manager menu 
    • Banners submenu


cmProManufacturer

boolean

Used to access data in:

  • Campaign Manager menu 
    • Properties submenu
      • Manufacturer tab


cmProBrands

boolean

Used to access data in:

  • Campaign Manager menu 
    • Properties submenu
      • Brands tab


cmProCategories

boolean

Used to access data in:

  • Campaign Manager menu 
    • Properties submenu
      • Categories tab


cmProRevenueClass

boolean

Used to access data in:

  • Campaign Manager menu 
    • Properties submenu
      • Revenue tab


cmProFillers

boolean

Used to access data in:

  • Campaign Manager menu 
    • Properties submenu
      • Fillers tab


cmProInserts

boolean

Used to access data in:

  • Campaign Manager menu 
    • Properties submenu
      • Asset Inserts tab


cmProPresentations

boolean

Used to access data in:

  • Campaign Manager menu 
    • Properties submenu
      • Presentations tab


cmProSettings

boolean

Used to access data in:

  • Campaign Manager menu 
    • Properties submenu
      • Settings tab


cmProReports

boolean

Used to access data in:

  • Campaign Manager menu 
    • Properties submenu
      • Reports tab


cmProInventory

boolean

Used to access data in:

  • Campaign Manager menu 
    • Properties submenu
      • Inventory tab


cmInventory

int

Used to access data in:

  • Campaign Manager menu 
    • Inventory submenu


cmProDisclaimer

boolean

Used to access data in:

  • Campaign Manager menu 
    • Properties submenu
      • Disclaimer tab


cmReports

int

Used to access data in:

  • Campaign Manager menu 
    • Reports submenu


isTVControl

boolean

Used to access data in: 

  • Player Config menu 
    • TV Control submenu


isDownloadControl

boolean

Used to access data in:

  • Player Config menu 
    • Download Control submenu


isRemoteSetup

boolean

Used to access data in: 

  • Player Config menu 
    • Remote Setup submenu


isBDeploy

boolean

Used to access data in:

  • Player Config menu 
    • B-Deploy submenu


isPlayerSetup

boolean

Used to access data in:

  • Player Config menu 
    • Player Setup submenu


isSmartActions

boolean

Used to access data in:

  • Player Config menu 
    • Smart Actions submenu


isStocks

boolean

Used to access data in:

  • Player Config menu 
    • Stock Market submenu


isLicenses

boolean

Used to access data in:

  • System Config menu 
    • Licenses submenu


isUsers

boolean

Used to access data in:

  • System Config menu 
    • Profiles/Users submenu


isSetupUser

boolean

Used to access data in:

  • System Config menu 
    • Settings submenu


isPlayListStandard

boolean

Used to access data in:

  • Content menu 
    • Playlist submenu


isDayparting

boolean

Used to access data in:

  • Content menu 
    • dayparting submenu


isAdminClients

boolean

Used to access data in:

  • System Config menu 
    • Clients submenu


Response 401

If you dont send any token, then you will receive a error message of "unauthorized", look at the next example:

Copy code{
    "error": "unauthorized",
    "error_description": "Full authentication is required to access this resource"
}



If you send a Token, but the Token you are sending is expired, then you will receive a response message with an "invalid_token" error, look at the next example:


Copy code{
    "error": "invalid_token",
    "error_description": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MDM2MTk5NzMsInVzZXJfbmFtZSI6ImFsZWphbmRyby56YW5hYnJpYUBkaWdpd29ya3MuY29tLm14IiwiYXV0aG9yaXRpZXMiOlsiUk9MRV9TWVNURU1BRE1JTiJdLCJqdGkiOiJHTGtQb3hQbVRTZUs2RFhmc1NfNkUxRkMxZmsiLCJjbGllbnRfaWQiOiJ6eW5jaHJvIiwic2NvcGUiOlsicmVhZCIsIndyaXRlIl19.yAFbdU18wMtQXSGUY3_noQn4BQv0RqYjDbw0sr1x6Yk"
}


This is the data retrieved when the 401 Unauthorized is retrieved:

Field
SubField
Type
Description

error

 

text

The type of the error, can be:

  • unauthorized
  • invalid_token


error_description


text

The description of the error, for the "invalid_token", this field retrieves the bearer token you're sending


Postman collection

File: