1. API Guide
  2. ISR Provisioning API
  3. REST API Sample Workflow

REST API Sample Workflow

This section provides a sample Provisional API workflow and important information regarding the REST APIs.
  • POST /authenticate
    Authentication is the initial process for all API requests and is a mandatory step. Enter the required username and password to access the authentication token. These are the same credentials used to access the Dashboard.

    Note:

    Ensure you have a valid token before accessing the API. Authentication tokens are only valid for a certain amount of time.
  • GET /accounts

    Provides a list of accounts for the signed in user only.

  • POST /accounts

    Provides the required information to create an account. Account details are provided by the user except accountId, which is generated by the system.

  • POST /accounts/search

    Search any account by providing valid fields in the request.

  • POST /accounts/upload

    Import a CSV file with a list of accounts.

  • DELETE /accounts/

    Deletes the specified account. You can access a list of accounts using the GET /accounts API. Once you delete an account it is permanently deleted and cannot be retrieved.

  • GET /accounts/{accountId}

    Get account details for the specified account. You can access a list of accounts using the GET /accounts API.

  • PATCH /accounts/{accountId}

    Update the specified account with this patch. You can access a list of accounts using the GET /accounts API.

  • PUT /accounts/{accountId}

    Update the data for the specified account. You can access a list of accounts using the GET /accounts API.

  • PATCH /accounts/{accountId}/routes

    Archive all of the recordings for the specified account in the provided location.

  • GET /accounts/{accountId}/routes

    Provides you with the routes list for the account. You can access a list of accounts using the GET /accounts API.

  • GET /codecProfile

    Provides a list of codecProfiles.

  • POST /codecProfile

    Provides the required information to create the codecProfile.

  • PUT /codecProfile/codecMapEntry/{codecMapId}/recordingFormat/{recordingFormatId}

    Updates recording formats. Use the GET /codecProfile/codecProfileName/{codecProfileName} API to retrieve the codec map ID and Recording format ID. Use the GET /codecProfile/transmissionCodec API to retrieve transmission codecs.

  • GET /codecProfile/codecProfileName/{codecProfileName}

    Retrieves the details of the recording format profile. Provides the list of transmission codecs and recording format set for each of the transmission codecs.

  • GET /codecProfile/recordingFormat

    Provides a list of supported recording formats.

  • GET /codecProfile/transmissionCodec

    Provides a list of transmission codecs.

  • DELETE /codecProfile/{codecProfileId}

    Deletes a specified recording. Use the GET /codecProfile/codecProfileName/{codecProfileName} API to retrieve the codec profile ID.

  • GET /codecProfile/{codecProfileId }

    Provides you with the details of the specified codec profile. Use the GET /codecProfile/codecProfileName/{codecProfileName} API to retrieve the codecProfile ID.

  • PUT /codecProfile/{codecProfileId}

    Updates the details of the specified codecProfile. Use the GET /codecProfile API to retrieve a list of codecProfiles.

  • GET /routes

    Provides a list of routes in the system.

  • POST /routes

    Provides the required information to create a route.

  • POST /routes/search

    Search any route by providing valid fields in the request.

  • POST /routes/upload

    Import a CSV file with a list of routes.

  • DELETE /routes/{routeId}

    Delete the specified route from the system. Use the GET /routes API to retrieve a list of routes.

  • GET /routes/{routeId}

    Provides you with the details for the specified route. Use the GET /routes API to retrieve a list of routes.

  • PATCH /routes/{routeId}

    Update the specified route with this patch. Use the GET /routes API to retrieve a list of routes.

  • PUT /routes/{routeId}

    Update the data for the specified route. Use the GET /routes API to retrieve a list of routes.

  • GET /routes/{routeId}/routeGroup

    Provides a list of route groups associated with the specified route. Use the GET /routes API to retrieve a list of routes.

  • POST /routes/{routeId}/routeGroup

    Creates a specific routeGroup for a particular route. Use the GET /routes API to retrieve a list of routes.

  • DELETE /routes/{routeId}/routegroup/{memberId}

    Deletes a specified routeGroup. Use the GET /routes/{routeId}/routeGroup API to retrieve a list of routeGroups.

  • GET /users

    Provides a list of users.

  • POST /users

    Provides the required information to create a user.

  • POST /users/upload

    Import a CSV file with a list of users.

  • GET /users/userName/{userName}

    Provides details of the specified user.

  • DELETE /users/{userID}

    Deletes the specified user. Use the GET /users API to get the User ID.

  • GET /users/{userId}

    Provides you with the details for the specified user. Use the GET /users API to retrieve a list of users.

  • PATCH /users/{userId}

    Update the specified user with this patch. Use the GET /users API to retrieve a list of users.

  • DELETE /users/{userId}/userAccount/{accountId}

    Deletes the specified user account. Use the GET /users API to retrieve a list of users. Use the POST /account/search API to get the account ID.

  • PUT /users/{userId}/userAccount/{accountId}

    Adds the specified user to the specified account. Use the GET /users API to retrieve a list of users. Use the POST /account/search API to get the account ID.

  • PUT /users/{userId}/userRoute/{routeId}

    Adds the specified user to the specified route. Use the GET /users API to retrieve a list of users. Use the POST /routes/search API to get the route ID.

  • DELETE /users/{userId}/userRoute/{routeId)

    Deletes the specified user from the specified route. Use the GET /users API to retrieve a list of users. Use the POST /routes/search API to get the route ID.