APINPRF

#### Search Results

Search

# APINPRF

This API lets obtain data from a PAC profile, create a new profile, and modify an existing one.

APINPRF can be invoked with:

    CALLNAT 'APINPRF' API-PARM API-PRF-PARM

A definition of API-PARM is provided in LDA UGNLPARM in library SYSPACUS.

A | add a profile
D | obtain data from a profile
M | modify a profile

This document covers the following topics:

- Local Data Area UPILPRF

- API Return Codes

## Local Data Area UPILPRF

A definition of API-PRF-PARM is provided in LDA UPILPRF in library SYSPACUS.

Field Name | Format | I/O
--- | --- | ---
API-PRF-PARM |  |
PROFILE | A8 | in
NAME | A32 | in/out
BATCH-ID | A8 | in/out
LIST-LOCKED | A1 | in/out
RIGHTS | A20 | in/out
ADMINISTRATION | A1 |
AUTHORISATION | A1 |
SUBMISSION | A1 |
2X | A1 |
APPLICATION | A1 |
LINK | A1 |
CCL | A1 |
FTT | A1 |
JCL-TEXT | A1 |
KEYWORD | A1 |
MAINT-REQUEST | A1 |
EVENT | A1 |
PATH | A1 |
OBJECT | A1 |
STATUS | A1 |
ADD-DATE | T | out
ADD-BY | A8 | out
ADD-TID | A8 | out
MOD-DATE | T | out
MOD-BY | A8 | out
MOD-TID | A8 | out

If [API-PARM.API-MAIN-FUNC] = 'A' and the profile is not found, APINPRF tries to add a profile with the characteristics specified in the "in/out" fields.

If [API-PARM.API-MAIN-FUNC] = 'D' and the profile is found, APINPRF returns in the remaining parameter fields the profile data, ignoring any values put by the user in the "in/out" fields.

If [API-PARM.API-MAIN-FUNC] = 'M' and the profile is found, APINPRF tries to modify the profile endowing it with the characteristics specified in the "in/out" fields.

The meaningful values of the "in/out" fields are listed in the following table.

NAME | A32 | any
BATCH-ID | A8 | any
LIST-LOCKED | A1 | Y, N
ADMINISTRATION | A1 | Y, N
AUTHORISATION | A1 | Y, N
SUBMISSION | A1 | Y, N
APPLICATION | A1 | M, R, N
LINK | A1 | M, R, N
CCL | A1 | R, N
FTT | A1 | M, R, N
JCL-TEXT | A1 | M, R, N
KEYWORD | A1 | M, R, N
MAINT-REQUEST | A1 | M, R, N
EVENT | A1 | M, R, N
PATH | A1 | M, R, N
OBJECT | A1 | R, N
STATUS | A1 | M, R, N

The meanings of the values are the same as those of their menu system counterparts.

## API Return Codes

APINPRF returns the following [API-PARM.API-MSG-NO]:

1011 | if an [API-PARM.API-MAIN-FUNC] distinct from A, D and M has been specified,
7250 | if the profile has been found,
7251 | if the profile has not been found,
7253 | if the profile has been added,
7254 | if the profile has been modified,
7264 | if the profile (to be modified) is held,
7407 | if a meaningless [API-PRF-PARM.LIST-LOCKED] has been specified,
7600 | if a meaningless [API-PRF-PARM.ADMINISTRATION], [API-PRF-PARM.AUTHORISATION], or [API-PRF-PARM.SUBMISSION] has been specified,
7601 | if a meaningless value has been specified for any of the redefined members of [API-PRF-PARM.RIGHTS] not covered by 7600.

Other values of API-PARM.API-MSG-NO may be received in more unusual situations.

### On this page

- Local Data Area UPILPRF
- API Return Codes