Jump to

• Request
• Response
• Examples

Create Locations

post

/appstore/publisher/v1/services/{listingVersionId}/locations

Creates service location .

Request

Supported Media Types

• application/xml
• application/json

Path Parameters

• listingVersionId: integer(int64)
  Listing ID for the screenshot to delete.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Location

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Location"
    }
}

Nested Schema : Location

Type: object

Show Source

• addressLocation(optional): string
• city(optional): string
• contactEmail(optional): string
• contactPhone(optional): string
• country(optional): object Item
• fax(optional): string
• id(optional): integer(int64)
• latitude(optional): string
• locationName(optional): string
• longitude(optional): string
• region(optional): object Item
• state(optional): string
• street(optional): string
• websiteUrl(optional): string
• zipCode(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "locationName":{
            "type":"string"
        },
        "addressLocation":{
            "type":"string"
        },
        "street":{
            "type":"string"
        },
        "city":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "country":{
            "$ref":"#/definitions/Item"
        },
        "zipCode":{
            "type":"string"
        },
        "contactPhone":{
            "type":"string"
        },
        "contactEmail":{
            "type":"string"
        },
        "fax":{
            "type":"string"
        },
        "websiteUrl":{
            "type":"string"
        },
        "region":{
            "$ref":"#/definitions/Item"
        },
        "latitude":{
            "type":"string"
        },
        "longitude":{
            "type":"string"
        }
    }
}

Nested Schema : Item

Type: object

Show Source

• code(optional): string
• name(optional): string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json;qs=1
• application/xml;qs=.5

200 Response

Successful Operation

Body ()

Root Schema : collection

Type: object

Show Source

• count(optional): integer(int32)
• hasMore(optional): boolean
  Default Value: false
• items(optional): array items
• links(optional): array link
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "xml":{
                "name":"items",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/Acknowledgement"
            }
        },
        "hasMore":{
            "type":"boolean",
            "default":false
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "xml":{
                "name":"link",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"collection"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object acknowledgement

{
    "type":"array",
    "xml":{
        "name":"items",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/Acknowledgement"
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "xml":{
        "name":"link",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : acknowledgement

Type: object

Show Source

• contentURL(optional): string
• entityId(optional): string
• message(optional): string
• name(optional): string
• uri(optional): string

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string"
        },
        "entityId":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "uri":{
            "type":"string"
        },
        "contentURL":{
            "type":"string"
        }
    },
    "xml":{
        "name":"acknowledgement"
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• rel(optional): string
  Allowed Values: [ "SELF", "CANONICAL", "NEXT", "TEMPLATE", "PREV" ]

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "xml":{
                "attribute":true
            },
            "enum":[
                "SELF",
                "CANONICAL",
                "NEXT",
                "TEMPLATE",
                "PREV"
            ]
        },
        "href":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        }
    }
}

400 Response

Invalid Parameter Value

401 Response

Not Authorized

404 Response

Entity Not Found

500 Response

System Error

Back to Top

Examples

The following example creates geo-graphic locations for the existing service, by submitting a POST request on the REST resource using cURL.

cURL Example

curl -X POST -H "Authorization: Bearer Access-token"  -H "X-Oracle-UserId: partner-email" "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/services/9483951/locations"

Request Header

Authorization: Bearer Access-token 
X-Oracle-UserId: [e-mail] 

Request Body

[
  {
    "locationName":"Regional Office",
    
    "city":"Chennai",
    "country":{
      "code":"india"
    },
    "addressLocation":"Tamilnadu",
    "zipCode":"10899",
    "contactPhone":"87654332345",
    "contactEmail":"[e-mail]",
    "fax":"8762767",
    "websiteUrl":"https://www.oracle.com/index.html",
    "regions":[
        {
        "name":"africa",
        "code":"AFRICA" 
        },
        {
         "name":"japan",
         "code":"JAPAN"
        }
     ]
  },
  {
    "locationName":"Head Office",
    "addressLocation":"Anna st",
    "city":"Banglore",
    "state":"Tamilnadu",
    "country":{
      "code":"india"
    },
    "zipCode":"10899",
    "contactPhone":"87654332345",
    "contactEmail":"[e-mail]",
    "fax":"8762767",
    "websiteUrl":"https://www.oracle.com/index.html",
    "regions":[
        {
            "code":"EUROPE",
            "name":"Europe"
        }
    ]
    }
]

HTTP Status Code:

200 OK

JSON Response:

{
  "items": [
    {
      "acknowledgement": {
        "message": "Partner location Created Successfully",
        "entityId": "127892090",
        "name": "Regional Office"
      }
    },
    {
      "acknowledgement": {
        "message": "Partner location Created Successfully",
        "entityId": "127892094",
        "name": "Head Office"
      }
    }
  ],
  "hasMore": false,
  "count": 0,
  "totalResults": 0,
  "links": [
    {
      "rel": "CANONICAL",
      "href": "https://slc08zff.us.oracle.com:7101/appstore/publisher/v1/services/109104577/locations"
    },
    {
      "rel": "SELF",
      "href": "https://slc08zff.us.oracle.com:7101/appstore/publisher/v1/services/109104577/locations"
    }
  ]
}

Back to Top