GetRecordExtended (Application-Level)

You are here:

This method helps to get the application data from primary table as well as its secondary table associated with record id.

Authentication

This method requires an authentication token regardless of the access level of the application.

Request

Target Endpoint

POST /Api/Applications/GetRecordExtended

 

Parameters

Property Name

Type

Is Required?

Description

ApplicationKeyStringRequiredThe application key, corresponding to your specific web service application. This constitutes the identifier for the requested resource.
RecordIdintRequiredRecordId of application data that will be retrieved from the primary table.
UserNameStringRequiredUsername of the person trying to access the record.
 Request Sample

Headers

POST /Api/Applications/GetRecordExtended HTTP/1.1
Authorization: Bearer Do3l_2l3uLdmYX76u-BufLzuuhFPOE-nRZDyU0adiFk1
Content-Type: application/json
Host: dev7.pagos.com

Body (formatted)

{
       "RecordId": 1,
       "UserName": "ssweb",
       "ApplicationKey": "a4dcfb4f0464453b928ce1d6bcfb6aa3"
}
Response

Property Name

Type

Description

SuccessBooleanIndicated whether or not the request was successful in getting the data record based on the provided token and application key.
PrimaryTableobject with schema:

 

{

“FieldName”: “Value”

}

All application data in primary table associated with Record Id.
SecondaryTablesobject with schema:

 

{

“TableName”: [

{

{

“Items”: {

“FieldName”: “Value”,

“SSWebCachingInfo”: “”,

“ID”: “1”,

“ForeignKeyId”: “1”

},

“SequenceId”: 1

}

}

]

}

All application data in secondary tables associated with Record Id.
InvalidTokenBooleanIf the request is unsuccessful, indicates whether or not the failure was due to token.
MessagesArray of StringA list of messages, which can be used or captured for diagnostics. When requests are unsuccessful, the reason for the failure will be documented in the Messages list.
Note: If the authentication token used in the request does not support impersonation, response will not be successful.
Response Sample (Success)

Headers

HTTP/1.1 200 OK
Cache-Control: no-cache, no-store
Content-Type: application/json; charset=utf-8

Body (formatted)

{
       "PrimaryTable": {
             "Description": "deneme",
             "InputA": "3",
             "InputB": "6",
             "InputC": "7",
             "OutputA": "16",
             "PagosMultiTable_TableInput": "",
             "ID": "1",
             "UserName": "",
             "EntryDate": "4/10/2018 2:36:52 PM",
             "LastUpdateDate": "4/10/2018 2:36:52 PM",
             "CurrentStatusIndex": "0",
             "intLastEditUserID": "",
             "dtLastEdit": "",
             "EditID": "",
             "IsActive": "True",
             "intVersionId": "23",
             "intExtensionId": "",
             "intGroupId": "",
             "OverwriteFbi": "",
             "VersionID": "",
             "intCounter": "",
             "SSWebCachingInfo": ""
       },
       "SecondaryTables": {
             "TableInput": [
                    {
                           "Items": {
                                  "Column1": "1",
                                  "Column2": "2",
                                  "Column3": "3",
                                  "SSWebCachingInfo": "",
                                  "ID": "1",
                                  "ForeignKeyId": "1"
                           },
                           "SequenceId": 1
                    },
                    {
                           "Items": {
                                  "Column1": "4",
                                  "Column2": "5",
                                  "Column3": "6",
                                  "SSWebCachingInfo": "",
                                  "ID": "2",
                                  "ForeignKeyId": "1"
                           },
                           "SequenceId": 2
                    }
             ]
       },
       "Success": true,
       "InvalidToken": false,
       "Messages": []
}

 

Response Sample (Failure)

Headers

HTTP/1.1 200 OK
Cache-Control: no-cache, no-store
Content-Type: application/json; charset=utf-8

Body (formatted)

Example 1:

{
       "PrimaryTable": {},
       "SecondaryTables": {},
       "Success": false,
       "InvalidToken": false,
       "Messages": [
             "The associated token does not have rights to access these resources."
       ]
}
Example 2:
{
       "PrimaryTable": {},
       "SecondaryTables": {},
       "Success": false,
       "InvalidToken": true,
       "Messages": [
             "The requested resource is restricted and your request did not provide a valid token."
       ]
}