MediaConnect AS
Powered by Redocly

External Reference

Remove external reference - client mode

Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.

SecurityClient_Credentials
Request
path Parameters
customerNumber
required
integer

Customer number

referenceCode
required
string

Reference code

Responses
200

OK

Response Schema: application/json
success
boolean

Informs if operation response is successful.

  • true: The external reference was deleted.
  • false The external reference was not deleted.
400

Bad Request

429

Too Many Requests

500

Internal Server Error

delete/v1/client/customer/{customerNumber}/external-reference/{referenceCode}
Request samples 
Response samples 
application/json
{
  • "success": true
}
Change external reference - client mode
Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.


SecurityClient_Credentials 
Request 
path Parameters
customerNumber
required
integer
Customer number


 
referenceCode
required
string
Reference code


 
Request Body schema: application/json
externalId
required
string  [ 1 .. 16 ] characters 
External ID


 
Responses 
200
OK


Response Schema: application/json
success
boolean
Informs if operation response is successful.


    

  • true: The external reference was updated.
    • 

  • false The external reference was not updated.
    • 



 
400
Bad Request


429
Too Many Requests


500
500 Internal Server Error


patch/v1/client/customer/{customerNumber}/external-reference/{referenceCode}
Request samples 
application/json
{
  • "externalId": "1"
}
Response samples 
application/json
{
  • "success": true
}
List external references - client mode
Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.


Use this API to list all availble external references for selected customer.


SecurityClient_Credentials 
Request 
path Parameters
customerNumber
required
integer
Customer number


 
Responses 
200
OK


Response Schema: application/json
Array of objects
 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


get/v1/client/customer/{customerNumber}/external-reference
Request samples 
Response samples 
application/json
{
  • "externalReferences": [
    ]
}
Register external reference - client mode
Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.


Used to register external reference for selected customer.


SecurityClient_Credentials 
Request 
path Parameters
customerNumber
required
integer
Customer number


 
Request Body schema: application/json
referenceCode
required
string  [ 1 .. 12 ] characters 
Reference code


 
externalId
required
string  [ 1 .. 16 ] characters 
External ID


 
Responses 
200
OK


Response Schema: application/json
success
boolean
Informs if operation response is successful.


    

  • true: The external reference was created.
    • 

  • false The external reference was not created.
    • 



 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


post/v1/client/customer/{customerNumber}/external-reference
Request samples 
application/json
{
  • "referenceCode": "TOTT",
  • "externalId": "1               "
}
Response samples 
application/json
{
  • "success": true
}
➔ Next to Article