Example Client APIs - Game App Messages

Game App Messages APIs

Click an API to expand/collapse it.

POSTAdd App Message

Description

Adds a new app message.

Request Endpoint

POST https://<Example api server address>/admin/message

Parameters

None.

cURL syntax
curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"action\" : \"common.invalid.minute\",
    \"message\" : \"Invalid minute\",
    \"language\" : \"English\",
    \"context\": \"STORE\"
}" \
'https://core.dev.Example.net/api/admin/message'
POST body attributes (JSON)

Attribute Type Use Description

action String Required "action" is the key.

message String Required "message" is a string value.

language String Required Language can be any human language (default is en).

POST body
Headers: Content-Type: application/json
{
  "action": "common.invalid.minute",
  "message": "Invalid minute",
  "language": "English",
  "context": "STORE"
}
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "id": "19f90880-a327-4361-a31f-148ed1398f9e",
    "updatedBy": "",
    "action": "common.invalid.minute",
    "message": "Invalid minute",
    "language": "English",
    "context": "STORE"
  },
  "detail": null,
  "error": false,
  "message": "Adding Message successful"
}
Return to top

Attribute	Type	Use	Description
`action`	String	Required	"action" is the key.
`message`	String	Required	"message" is a string value.
`language`	String	Required	Language can be any human language (default is en).

DELETEDelete App Message

Description

Deletes an existing app message.

Request Endpoint

DELETE https://<Example api server address>/admin/message/{id}

Parameters

Parameter Type Use Description

id String Required UUID of an existing app message.

cURL syntax
curl --include \
     --request DELETE \
'https://core.dev.Example.net/api/admin/message/id'
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": true,
  "detail": null,
  "error": false,
  "message": "Deleting store and SDK message successful"
}
Return to top

Parameter	Type	Use	Description
id	String	Required	UUID of an existing app message.

GETExport App Messages

Description

Exports app messages.

Request Endpoint

GET https://<Example api server address>/admin/lang/message?{langCode}&{context}

Parameters

Parameter Type Use Description

langCode String Required Language of the requested messages.

context String Required Context of the app messages ("STORE" or "SDK").

cURL syntax
curl --include \
'https://core.dev.Example.net/api/admin/lang/message?langCode=en&context=STORE'
Response body
Headers: Content-Type: application/xml | HTTPS Status Code: 200
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
  <data date="2016-06-09T14:34:52.142+05:30" lang="en">
    <text name="common.invalid.number">invalid number</text>
  </data>
Return to top

Parameter	Type	Use	Description
langCode	String	Required	Language of the requested messages.
context	String	Required	Context of the app messages ("STORE" or "SDK").

GETFetch All App Messages

Description

Fetches all the app messages.

Request Endpoint

GET https://<Example api server address>/admin/message

Parameters

None.

cURL syntax
curl --include \
'https://core.dev.Example.net/api/admin/message'
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": [
    {
      "id": "a4fb8afe-8eea-4f25-a68d-f0e62733e002",
      "updatedBy": "",
      "action": "common.invalid.number",
      "message": "Invalid number",
      "language": "English",
      "context": "STORE"
    }
  ],
  "detail": null,
  "error": false,
  "message": "Fetching Messages info successful"
}
Return to top

POSTFetch by Action

Description

Fetches app messages by action.

Request Endpoint

POST https://<Example api server address>/admin/message/by/action

Parameters

None.

cURL syntax
curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"action\" : \"common.invalid.number\",
    \"language\" : \"US\"
}" \
'https://core.dev.Example.net/api/admin/message/by/action'
POST body attributes (JSON)

Attribute Type Use Description

action String Required "action" is the key.

language String Optional Language can be any human language (default is en).

POST body
Headers: Content-Type: application/json
{
  "action": "common.invalid.number",
  "language": "US"
}
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": "Invalid number",
  "detail": null,
  "error": false,
  "message": "Fetching store and sdk messages successful"
}
Return to top

Attribute	Type	Use	Description
`action`	String	Required	"action" is the key.
`language`	String	Optional	Language can be any human language (default is en).

POSTImport App Messages

Description

Request Endpoint

POST https://<Example api server address>/admin/lang/message?{langCode}&{context}

Parameters

None.

cURL syntax
curl --include \
     --request POST \
'https://core.dev.Example.net/api/admin/lang/message?langCode=en&context=STORE'
POST body attributes (JSON)

Attribute Type Use Description

messageXml String Required Should be a valid XML file.

POST body
Headers: Content-Type: multipart/form-data, boundary=AaB03x Accept-Encoding: Should be multipart/form-data Content-Type: multipart/form-data
Upload multipart-image with variable name "messageXml"

 
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
  <data date="2016-06-09T14:34:52.142+05:30" lang="en">
    <text name="common.invalid.number">invalid number</text>
  </data>
Response body
Headers:Content-Type: multipart/form-data, boundary=AaB03x Accept-Encoding: Should be multipart/form-data Content-Type: application/json
{
  "data": [
    {
      "action": "common.invalid.number",
      "context": "SDK",
      "id": "d5f522ad-375e-4abb-9101-f64c70aa995d",
      "language": "en",
      "message": "invalid number"
    }
  ],
  "detail": null,
  "error": false,
  "message": "Successfully imported messages"
}
Return to top

Attribute	Type	Use	Description
`messageXml`	String	Required	Should be a valid XML file.

PUTUpdate App Message

Description

Updates an existing app message.

Request Endpoint

PUT https://<Example api server address>/admin/message/{id}

Parameters

Parameter Type Use Description

id String Required UUID of an existing app message.

cURL syntax
curl --include \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"message\" : \"xyz is unknown\"
}" \
'https://core.dev.Example.net/api/admin/message/id'
PUT body
Headers: Content-Type: application/json
{
  "message": "xyz is unknown"
}
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "id": "0b4817e9-d5bc-4835-a085-7ebe63e04ef9",
    "updatedBy": "",
    "action": "common.invalid.input",
    "message": "xyz is unknown",
    "language": "English",
    "context": "STORE"
  },
  "detail": null,
  "error": false,
  "message": "Updating storeAndSDk Messages info successful"
}
Return to top