Jump to

• Request
• Response

Get all registered users

get

/fscmRestApi/resources/11.13.18.05/userRegistrations

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds all users that match the primary key criteria specified.
    Finder Variables
    • RegistrationId; integer; Unique identifier for the user registration.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ApprovalStatusCode; string; The status code of the approval.
  • CartHeaderId; integer; The unique identifier for the shopping cart header of the user.
  • EmailAddress; string; The e-mail address of the user.
  • PartyId; integer; The unique identifier for user.
  • ProxyGroupId; integer; The unique identifier of the managed student group to which the user should be added after the user account is created.
  • RegistrationId; integer; The unique identifier for a user registration.
  • RegistrationStatusCode; string; The current status of user registration. Accepted codes are REQUEST and COMPLETE.
  • RelatedPersonEmailAddress; string; The email address of the related person.
  • RelatedPersonPartyId; integer; The party ID of the related person.
  • RelationshipCode; string; The code of the relationship.
  • RelationshipTypeCode; string; The type of the relationship.
  • StorefrontId; integer; The unique identifier for the storefront of the user.
  • Username; string; The user name of the user.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : userRegistrations

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/userRegistrations-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object userRegistrations-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/userRegistrations-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : userRegistrations-item-response

Type: object

Show Source

• AddressFour: string
  Title: Address Four

  Maximum Length: 240

  The fourth line for address.
• AddressOne: string
  Title: Address One

  Maximum Length: 240

  The first line for address.
• AddressThree: string
  Title: Address Three

  Maximum Length: 240

  The third line for address.
• AddressTwo: string
  Title: Address Two

  Maximum Length: 240

  The second line for address.
• ApprovalStatusCode: string
  Title: Approval Status Code

  Maximum Length: 30

  The status code of the approval.
• Building: string
  Title: Building

  Maximum Length: 240

  The building name or number at a given address.
• CartHeaderId: integer (int64)
  Title: Cart Header ID

  The unique identifier for the shopping cart header of the user.
• City: string
  Title: City

  Maximum Length: 60

  The city of the address.
• CountryCode: string
  Title: Country Code

  Maximum Length: 2

  The country code from the TERRITORY_CODE column in the FND_TERRITORY table.
• County: string
  Title: County

  Maximum Length: 60

  The county of the address.
• DateOfBirth: string (date)
  Title: Date of Birth

  The date of birth of the user.
• EmailAddress: string
  Title: Email Address

  Maximum Length: 320

  The e-mail address of the user.
• FirstName: string
  Title: First Name

  Maximum Length: 150

  The first name of the user.
• FloorNumber: string
  Title: Floor Number

  Maximum Length: 40

  The floor number at a given address or in a particular building when building number is provided.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name of the user.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MiddleName: string
  Title: Middle Name

  Maximum Length: 60

  The middle name of the user.
• NameSuffix: string
  Title: Name Suffix

  Maximum Length: 30

  The suffix can be junior or senior.
• PartyId: integer (int64)
  Title: Party ID

  Read Only: true

  The unique identifier for user.
• PhoneAreaCode: string
  Title: Phone Area Code

  Maximum Length: 20

  The area code within a country code.
• PhoneCountryCode: string
  Title: Phone Country Code

  Maximum Length: 10

  The international country code for a phone number. For example, 33 for France.
• PhoneNumber: string
  Title: Phone Number

  Maximum Length: 40

  The phone number formatted in the local format. The number should not include area code, country code, or extension.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the address.
• Province: string
  Title: Province

  Maximum Length: 60

  The province of the address.
• ProxyGroupId: integer (int64)
  Title: Proxy Group ID

  The unique identifier of the managed student group to which the user should be added after the user account is created.
• RegistrationId: integer (int64)
  Title: User Registration ID

  Read Only: true

  The unique identifier for a user registration.
• RegistrationStatusCode: string
  Title: Registration Status Code

  Read Only: true

  The current status of user registration. Accepted codes are REQUEST and COMPLETE.
• RelatedPersonEmailAddress: string
  Title: Related Person Email Address

  Maximum Length: 320

  The email address of the related person.
• RelatedPersonPartyId: integer (int64)
  Title: Related Person Party ID

  The party ID of the related person.
• RelationshipCode: string
  Title: Relationship Code

  Maximum Length: 30

  The code of the relationship.
• RelationshipTypeCode: string
  Title: Relationship Type

  Maximum Length: 30

  The type of the relationship.
• ShoppingCartPayload: string (byte)
  Title: Shopping Cart Payload

  The shopping cart payload that the cloud application creates before user sign up.
• SingleNameFlag: boolean
  Title: Single Name

  Maximum Length: 1

  Default Value: false

  Indicates whether the user has single name.
• StateCode: string
  Title: State Code

  Maximum Length: 60

  The state code of the address.
• StorefrontId: integer (int64)
  Title: Storefront ID

  The unique identifier for the storefront of the user.
• Username: string
  Title: User Name

  Maximum Length: 100

  The user name of the user.

{
    "type":"object",
    "properties":{
        "AddressFour":{
            "title":"Address Four",
            "maxLength":240,
            "type":"string",
            "description":"The fourth line for address.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressOne":{
            "title":"Address One",
            "maxLength":240,
            "type":"string",
            "description":"The first line for address.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressThree":{
            "title":"Address Three",
            "maxLength":240,
            "type":"string",
            "description":"The third line for address.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressTwo":{
            "title":"Address Two",
            "maxLength":240,
            "type":"string",
            "description":"The second line for address.",
            "nullable":true,
            "x-queryable":false
        },
        "ApprovalStatusCode":{
            "title":"Approval Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the approval.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":240,
            "type":"string",
            "description":"The building name or number at a given address.",
            "nullable":true,
            "x-queryable":false
        },
        "CartHeaderId":{
            "title":"Cart Header ID",
            "type":"integer",
            "description":"The unique identifier for the shopping cart header of the user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":2,
            "type":"string",
            "description":"The country code from the TERRITORY_CODE column in the FND_TERRITORY table.",
            "nullable":true,
            "x-queryable":false
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "DateOfBirth":{
            "title":"Date of Birth",
            "type":"string",
            "description":"The date of birth of the user.",
            "format":"date",
            "nullable":false,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Email Address",
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address of the user.",
            "nullable":false,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the user.",
            "nullable":true,
            "x-queryable":false
        },
        "FloorNumber":{
            "title":"Floor Number",
            "maxLength":40,
            "type":"string",
            "description":"The floor number at a given address or in a particular building when building number is provided.",
            "nullable":true,
            "x-queryable":false
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the user.",
            "nullable":false,
            "x-queryable":false
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the user.",
            "nullable":true,
            "x-queryable":false
        },
        "NameSuffix":{
            "title":"Name Suffix",
            "maxLength":30,
            "type":"string",
            "description":"The suffix can be junior or senior.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier for user.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Phone Area Code",
            "maxLength":20,
            "type":"string",
            "description":"The area code within a country code.",
            "nullable":true,
            "x-queryable":false
        },
        "PhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The international country code for a phone number. For example, 33 for France.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PhoneNumber":{
            "title":"Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The phone number formatted in the local format. The number should not include area code, country code, or extension.",
            "nullable":true,
            "x-queryable":false
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "ProxyGroupId":{
            "title":"Proxy Group ID",
            "type":"integer",
            "description":"The unique identifier of the managed student group to which the user should be added after the user account is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RegistrationId":{
            "title":"User Registration ID",
            "type":"integer",
            "description":"The unique identifier for a user registration.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RegistrationStatusCode":{
            "title":"Registration Status Code",
            "type":"string",
            "description":"The current status of user registration. Accepted codes are REQUEST and COMPLETE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedPersonEmailAddress":{
            "title":"Related Person Email Address",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the related person.",
            "nullable":true,
            "x-queryable":true
        },
        "RelatedPersonPartyId":{
            "title":"Related Person Party ID",
            "type":"integer",
            "description":"The party ID of the related person.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelationshipCode":{
            "title":"Relationship Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the relationship.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelationshipTypeCode":{
            "title":"Relationship Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "ShoppingCartPayload":{
            "title":"Shopping Cart Payload",
            "type":"string",
            "description":"The shopping cart payload that the cloud application creates before user sign up.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SingleNameFlag":{
            "title":"Single Name",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the user has single name.",
            "nullable":false,
            "default":false,
            "x-queryable":false
        },
        "StateCode":{
            "title":"State Code",
            "maxLength":60,
            "type":"string",
            "description":"The state code of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "StorefrontId":{
            "title":"Storefront ID",
            "type":"integer",
            "description":"The unique identifier for the storefront of the user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Username":{
            "title":"User Name",
            "maxLength":100,
            "type":"string",
            "description":"The user name of the user.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

validateUserDetails

Operation: /fscmRestApi/resources/11.13.18.05/userRegistrations/action/validateUserDetails

Validates the user details to check whether such an account can be created.

Back to Top