Jump to

• Request
• Response

Update a user registration request

patch

/fscmRestApi/resources/11.13.18.05/userRegistrations/{RegistrationId}

Request

Path Parameters

• RegistrationId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ApprovalStatusCode: string
  Maximum Length: 30

  The status code of the approval.

{
    "type":"object",
    "properties":{
        "ApprovalStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"The status code of the approval.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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-item-response

Type: object

Show Source

• AddressFour: string
  Maximum Length: 240

  The fourth line for address.
• AddressOne: string
  Maximum Length: 240

  The first line for address.
• AddressThree: string
  Maximum Length: 240

  The third line for address.
• AddressTwo: string
  Maximum Length: 240

  The second line for address.
• ApprovalStatusCode: string
  Maximum Length: 30

  The status code of the approval.
• Building: string
  Maximum Length: 240

  The building name or number at a given address.
• CartHeaderId: integer (int64)
  The unique identifier for the shopping cart header of the user.
• City: string
  Maximum Length: 60

  The city of the address.
• CountryCode: string
  Maximum Length: 2

  The country code from the TERRITORY_CODE column in the FND_TERRITORY table.
• County: string
  Maximum Length: 60

  The county of the address.
• DateOfBirth: string (date)
  The date of birth of the user.
• EmailAddress: string
  Maximum Length: 320

  The e-mail address of the user.
• FirstName: string
  Maximum Length: 150

  The first name of the user.
• FloorNumber: string
  Maximum Length: 40

  The floor number at a given address or in a particular building when building number is provided.
• LastName: string
  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
  Maximum Length: 30

  The suffix can be junior or senior.
• PartyId: integer (int64)
  Read Only: true

  The unique identifier for user.
• PhoneAreaCode: string
  Maximum Length: 20

  The area code within a country code.
• PhoneCountryCode: string
  Maximum Length: 10

  The international country code for a phone number. For example, 33 for France.
• PhoneNumber: string
  Maximum Length: 40

  The phone number formatted in the local format. The number should not include area code, country code, or extension.
• PostalCode: string
  Maximum Length: 60

  The postal code of the address.
• Province: string
  Maximum Length: 60

  The province of the address.
• RegistrationId: integer (int64)
  Read Only: true

  The unique identifier for a user registration.
• RegistrationStatusCode: string
  Read Only: true

  The current status of user registration. Accepted codes are REQUEST and COMPLETE.
• RelatedPersonEmailAddress: string
  Maximum Length: 320

  The email address of the related person.
• RelatedPersonPartyId: integer (int64)
  The party ID of the related person.
• RelationshipCode: string
  Maximum Length: 30

  The code of the relationship.
• RelationshipTypeCode: string
  Maximum Length: 30

  The type of the relationship.
• ShoppingCartPayload: string (byte)
  The shopping cart payload that the cloud application creates before user sign up.
• SingleNameFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the user has single name.
• StateCode: string
  Maximum Length: 60

  The state code of the address.
• StorefrontId: integer (int64)
  The unique identifier for the storefront of the user.
• Username: string
  Maximum Length: 100

  The user name of the user.

{
    "type":"object",
    "properties":{
        "Building":{
            "maxLength":240,
            "type":"string",
            "description":"The building name or number at a given address.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressThree":{
            "maxLength":240,
            "type":"string",
            "description":"The third line for address.",
            "nullable":true,
            "x-queryable":false
        },
        "FloorNumber":{
            "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
        },
        "RelatedPersonPartyId":{
            "type":"integer",
            "description":"The party ID of the related person.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "ApprovalStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"The status code of the approval.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "PhoneCountryCode":{
            "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"
            }
        },
        "PhoneAreaCode":{
            "maxLength":20,
            "type":"string",
            "description":"The area code within a country code.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressFour":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line for address.",
            "nullable":true,
            "x-queryable":false
        },
        "CartHeaderId":{
            "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
        },
        "RelationshipCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code of the relationship.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AddressTwo":{
            "maxLength":240,
            "type":"string",
            "description":"The second line for address.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RegistrationStatusCode":{
            "type":"string",
            "description":"The current status of user registration. Accepted codes are REQUEST and COMPLETE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NameSuffix":{
            "maxLength":30,
            "type":"string",
            "description":"The suffix can be junior or senior.",
            "nullable":true,
            "x-queryable":true
        },
        "SingleNameFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the user has single name.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "CountryCode":{
            "maxLength":2,
            "type":"string",
            "description":"The country code from the TERRITORY_CODE column in the FND_TERRITORY table.",
            "nullable":true,
            "x-queryable":false
        },
        "ShoppingCartPayload":{
            "type":"string",
            "description":"The shopping cart payload that the cloud application creates before user sign up.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "DateOfBirth":{
            "type":"string",
            "description":"The date of birth of the user.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "FirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of the user.",
            "nullable":true,
            "x-queryable":true
        },
        "RegistrationId":{
            "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
        },
        "StateCode":{
            "maxLength":60,
            "type":"string",
            "description":"The state code of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "RelatedPersonEmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The email address of the related person.",
            "nullable":true,
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the user.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address of the user.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the address.",
            "nullable":true,
            "x-queryable":false
        },
        "RelationshipTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressOne":{
            "maxLength":240,
            "type":"string",
            "description":"The first line for address.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier for user.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Username":{
            "maxLength":100,
            "type":"string",
            "description":"The user name of the user.",
            "nullable":false,
            "x-queryable":true
        },
        "StorefrontId":{
            "type":"integer",
            "description":"The unique identifier for the storefront of the user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "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
        },
        "LastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of the user.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

ApprovalStatusCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEY_PROXY_MBR_APV_STATUS

The following properties are defined on the LOV link relation:

• Source Attribute: ApprovalStatusCode; Target Attribute: LookupCode
• Display Attribute: LookupCode

PhoneCountryCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedPhoneCountryCodes

The following properties are defined on the LOV link relation:

• Source Attribute: PhoneCountryCode; Target Attribute: PhoneCountryCode
• Display Attribute: PhoneCountryCode, TerritoryShortName

Back to Top