GET - /roaming

General Information


ServiceAPIMethodData ModelsWorkflow
oauth/roamingGETN/AN/A

Description

Cross environment roaming but requires IP whitelisting.

Input


Type: application/json


This API needs no Input parameters


Output

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response 

If the response is a valid one, the soajsinjectobj will be available in the header and by using soajs middleware you will be able to access its information from the request context

Valid Response

Valid Response Sample
{ 
  result: true,
  data: true
}

Invalid Response

Error Response Sample
{
    "result":false,
    "errors":{
        "codes":[404],
        "details":[
            {
                "code":404,
                "message":"Unable to roam the provided request"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes


Code
Description
404

Unable to roam the provided request