Fautore API: osaMemberReg

Return configuration data specific to requesting application.

Overview

This page details the use of the osaMemberReg API call. This function is used by applications to pull OCE member specific configuration items defined in the AppVal section of the application registration message. Values defined as "Default" are returned should there be no data defined for the OCE member triggering the request from the calling application.

Message Structure

The OCE function data structure is constructed of encoded JSON passed within the "Adjunct":"Data" portion of the master OSA message being used to provide the data to the OCE.

Function: osaMemberReg

Full Messge Example

{

          'Visibility' => '2',
          'Detail' => 'This is a base USDS data structure to build upon.',
          'msgType' => 'oceOp',
          'Summary' => 'Base USDS structure', 
          'Source' => {
                        'AppId' => 'Test:jsontest',
                        'Member' => 'Bonnie',
                        'AppKey' => '41T3007T8+HLKMQNOWQSUSH9A7-OI?!QCR56',
                        'Coterie' => '1'
          }
          'Adjunct' => {
                       'Desc' => 'An example osaMemberReg call',
                       'Type' => 'oce/func'                      
                       'Data' => '{
                                   "Func" : "osaMemberReg",
                                   "ReqLogin" : "Edgar",
                                   "Message" : "We met at the fuzzy convention",
                                   "Email" : "Vendor@Cichosz.org",
                                   "Avatar" : "",
                                   "FirstName" : "Edgar",
                                   "LastName" : "Horowitz",
                                   "ReqPass" : "SomePass"
                      }',

          } ,
};

Function Specific Call Data

Function specific JSON

{
    "Func" : "osaMemberReg",
    "ReqLogin" : "Edgar",
    "Message" : "We met at the fuzzy convention",
    "Email" : "Vendor@Cichosz.org",
    "Avatar" : "",
    "FirstName" : "Edgar",
    "LastName" : "Horowitz",
    "ReqPass" : "SomePass"
}

Returns:
The response returned is a standard JSON structure with 2 additional fields:

RespCount:
The number of API call responses being provided. This will always be "1" unless multiple API calls were sent at once.

MsgId:
An alpha numeric representing the message being returned. The string "REQPROC" (for "Request Processed") is the expected response for success.

MsgNum:
An integer value representing the message being returned.

Positive numbers indicate success
Negative numbers indicate an error has occurred

The number "7" is the expected response for success in this case.

Mesg::
Explanation message tied to the return code.

Login:
Value actually assigned as the login by the enrolling OCE.

Password:
Value actually assigned as the password by the enrolling OCE

Example Return JSON

{
   "Password" : "SomePass",
   "MsgId" : "REQPROC",
   "Login" : "Edgar",
   "Mesg" : "Request processed successfully - See log for details \n",
   "MsgNum" : "7",
   "respCount" : 1
}