Create locations

post

/fscmRestApi/resources/11.13.18.05/requisitionOneTimeLocations

Request

Header Parameters
  • 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".
  • 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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Additional Address Element 1
    Maximum Length: 150
    First additional address element to support flexible address format.
  • Title: Additional Address Element 2
    Maximum Length: 150
    Second additional address element to support flexible address format.
  • Title: Additional Address Element 3
    Maximum Length: 150
    Third additional address element to support flexible address format.
  • Title: Additional Address Element 4
    Maximum Length: 150
    Fourth additional address element to support flexible address format.
  • Title: Additional Address Element 5
    Maximum Length: 150
    Fifth additional address element to support flexible address format.
  • Title: Address Line 1
    Maximum Length: 240
    First line for the address.
  • Title: Address Line 2
    Maximum Length: 240
    Second line for the address.
  • Title: Address Line 3
    Maximum Length: 240
    Third line for the address.
  • Title: Address Line 4
    Maximum Length: 240
    Fourth line for the address.
  • Title: Address Lines Phonetic
    Maximum Length: 560
    Phonetic representation of the address.
  • Title: Building
    Maximum Length: 240
    Specific building name or number at the given address.
  • Title: City
    Maximum Length: 60
    Name of the city mentioned in the address.
  • Title: Territory Name
    Maximum Length: 80
    Country mentioned in the address.
  • Title: Country
    Maximum Length: 2
    County code mentioned in the address.
  • Title: County
    Maximum Length: 60
    County mentioned in the address.
  • Title: Floor
    Maximum Length: 40
    Number that identifies the specific floor at a given address or in a particular building when building number is provided.
  • Title: Postal Code
    Maximum Length: 60
    Postal code of the address.
  • Title: Postal Code Extension
    Maximum Length: 20
    Four digit extension to the United States postal ZIP code.
  • Title: Province
    Maximum Length: 60
    Province mentioned in the address.
  • Title: State
    Maximum Length: 60
    State mentioned in the address.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : requisitionOneTimeLocations-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to create locations.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/requisitionOneTimeLocations"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
	"AddrElementAttribute1": null,
	"AddrElementAttribute2": "VerifyAddrElementAttribute2",
	"AddrElementAttribute3": "VerifyAddrElementAttribute3",
	"AddrElementAttribute4": null,
	"AddrElementAttribute5": null,
	"Address1": "PRIVADA UNION",
	"Address2": "AGRICOLA PANTITLAN",
	"Address3": null,
	"Address4": null,
	"AddressLinesPhonetic": null,
	"Building": null,
	"City": "CIUDAD DE MEXICO",
	"County": null,
	"FloorNumber": null,
	"PostalCode": "08100",
	"PostalPlus4Code": null,
	"Province": null,
	"State": "CDMEX",
	"Country": "Mexico"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
	"AddrElementAttribute1": null,
	"AddrElementAttribute2": "VerifyAddrElementAttribute2",
	"AddrElementAttribute3": "VerifyAddrElementAttribute3",
	"AddrElementAttribute4": null,
	"AddrElementAttribute5": null,
	"Address1": "PRIVADA UNION",
	"Address2": "AGRICOLA PANTITLAN",
	"Address3": null,
	"Address4": null,
	"LocationId": 300100541617801,
	"AddressLinesPhonetic": null,
	"Building": null,
	"City": "CIUDAD DE MEXICO",
	"CountryCode": "MX",
	"County": null,
	"FloorNumber": null,
	"PostalCode": "08100",
	"PostalPlus4Code": null,
	"Province": null,
	"State": "CDMEX",
	"FormattedAddress": "PRIVADA UNION,AGRICOLA PANTITLAN,VerifyAddrElementAttribute3, VerifyAddrElementAttribute2,08100  CIUDAD DE MEXICO, CDMEX,MEXICO",
	"Country": "Mexico",
	"CreatedBy": "CVRQST09",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/requisitionOneTimeLocations/300100541617801",
		"name": "requisitionOneTimeLocations",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/requisitionOneTimeLocations/300100541617801",
		"name": "requisitionOneTimeLocations",
		"kind": "item"
	}
	]
}
Back to Top