Link Search Menu Expand Document

Overview

Create or Update the CsrInfo in a user’s subscription.

Authorization

Include an API Key as a query string parameter in the request URL

Request URL

https://rclapi.azure-api.net/v2/stand-alone/csrinfo?api-key={api key}

Method

PUT

Request Parameters

Name In Required Type Description
api-key query true string The user’s API Key for the subscription

Request Body

Add the CsrInfo object to be created or updated. Do NOT include the ‘id’ and ‘subscriptionId’ fields

Sample Request

{
    "countryName": "Trinidad",
    "locality": "Homeland Gardens",
    "state": "Cunupia",
    "organization": "Ray Consulting Limited",
    "organizationUnit": "IT"
}

Response

Name Type Description
201 Created CsrInfo The response body contains the specified CsrInfo object that was created
200 OK CsrInfo The response body contains the specified CsrInfo object that was updated

Sample Response

200 OK

{
    "id": 13,
    "countryName": "Trinidad",
    "locality": "Homeland Gardens",
    "state": "Cunupia",
    "organization": "Ray Consulting Limited",
    "organizationUnit": "IT",
    "subscriptionId": 15
}

201 Created

{
    "id": 13,
    "countryName": "Trinidad",
    "locality": "Homeland Gardens",
    "state": "Cunupia",
    "organization": "Ray Consulting Limited",
    "organizationUnit": "IT",
    "subscriptionId": 15
}

Definitions

CsrInfo

CsrInfo Object

Name Type Description
id int Unique id for the CsrInfo
countryName string The organization’s country
locality string The organization’s location/region
state string The organization’s country’s state
organization string The organization’s name
organizationUnit string The organization’s unit/department
subscriptionId int Unique id for the user’s subscription

Error

Name Code Description
Bad Request 400 Error details will be included as a string in the body of the response

Test the API

Note: Authorization in the Header is not supported for this API. Leave the authorization blank when testing. Use the API Key in the url parameter instead.

Test the API in the Developer’s Portal