AnsweredAssumed Answered

What are the values to be passed in getTagByNameRequest of 'Get Tag By Name' Resource

Question asked by Evanthika Amarasiri on May 1, 2018
Latest reply on May 1, 2018 by Evanthika Amarasiri

Like • Show 0 Likes0
Comment • 5

Hi,

I am trying to get results by calling the API Get Tag By Name by passing a request body (getTagByNameRequest) as explained in [1]. By looking at the documentation I cannot figure out what values I should pass with this payload.

{
  "maxReturn": 5,
  "name": "program",
  "offset": 1,
  "order": "string"
}

Do you think you can help me out here? Below would be the response I get from Get Tag Types

{
:   "success":true,
:   "errors":
:   [
:   ],
:   "requestId":"a66a#1631a8a344f",
:   "result":
:   [
:   :   {
:   :   :   "tagType":"Author",
:   :   :   "applicableProgramTypes":"[email_batch,program,nurture,event,webinar,in_app]",
:   :   :   "required":false
:   :   },
:   :   {
:   :   :   "tagType":"Campaign Topic",
:   :   :   "applicableProgramTypes":"[program,nurture,email_batch,in_app]",
:   :   :   "required":false
:   :   },

And the result I get from Get Tag by Name by passing the name would be

{
:   "success":true,
:   "errors":
:   [
:   ],
:   "requestId":"48df#1631a921f88",
:   "result":
:   [
:   :   {
:   :   :   "tagType":"Campaign Topic",
:   :   :   "applicableProgramTypes":"[program,nurture,email_batch,in_app]",
:   :   :   "required":false,
:   :   :   "allowableValues":"[xxx,yyy,zzzz,dddd,aaaa]"
:   :   }
:   ]
}

[1] - http://developers.marketo.com/rest-api/endpoint-reference/asset-endpoint-reference/#!/Tags/getTagByNameUsingGET

Sanford Whiteman May 1, 2018 5:33 PM

Correct Answer

Yes, I think your assumptions are right on.

Maybe the POST variation was intended to allow some other functionality (like a filter by some other characteristic) but it wasn't implemented. More likely it just isn't supposed to be in the docs.

See the reply in context

No one else had this question

Outcomes

Evanthika Amarasiri May 1, 2018 4:43 PM

Also, is there a specific reason to support GET with a body in this scenario? I noticed this for some other GET resources as well.Is there a specific reason why these methods are designed this way.

Actions

Sanford Whiteman May 1, 2018 5:07 PM

It isn't possible to send a body with a GET (you'd have to use POST and make it a "synthetic" GET by adding _method=GET to the query string).

But I think the docs are wrong here in any case. What would be the purpose of a paginated response, when by definition (unique tag names) there can only be one result by name?

Actions

Evanthika Amarasiri @ Sanford Whiteman on May 1, 2018 5:26 PM

Thanks for the response Sanford. You have a point. If we pass the tag name, it would return only one result and there is no point in passing maxReturn values etc. Therefore, can we conclude that the Marketing documentation is wrong and we should be able to invoke the below resource just by passing a tag name as a query parameter? Can we conclude saying that the getTagByNameRequest Body parameter is not required at all for this resource?

Based on this, we can do our API implementation and inform the front end team about the exact parameters to be passed.

/rest/asset/v1/tagType/byName.json

Actions

Sanford Whiteman @ Evanthika Amarasiri on May 1, 2018 5:33 PM

Yes, I think your assumptions are right on.

Maybe the POST variation was intended to allow some other functionality (like a filter by some other characteristic) but it wasn't implemented. More likely it just isn't supposed to be in the docs.

Actions

Evanthika Amarasiri @ Sanford Whiteman on May 1, 2018 5:37 PM

Awesome! Many thanks for the prompt responses. I will inform the relevant teams accordingly. Hope the documentation will be corrected in future.

Regards,

Evanthika

Actions

5 Replies

Evanthika Amarasiri May 1, 2018 4:43 PM
Mark Correct
Correct Answer
Also, is there a specific reason to support GET with a body in this scenario? I noticed this for some other GET resources as well.Is there a specific reason why these methods are designed this way.
Like • Show 0 Likes0
Actions
Sanford Whiteman May 1, 2018 5:07 PM
Mark Correct
Correct Answer
It isn't possible to send a body with a GET (you'd have to use POST and make it a "synthetic" GET by adding _method=GET to the query string).

But I think the docs are wrong here in any case. What would be the purpose of a paginated response, when by definition (unique tag names) there can only be one result by name?
Like • Show 0 Likes0
Actions
- Evanthika Amarasiri @ Sanford Whiteman on May 1, 2018 5:26 PM
  Mark Correct
  Correct Answer
  Thanks for the response Sanford. You have a point. If we pass the tag name, it would return only one result and there is no point in passing maxReturn values etc. Therefore, can we conclude that the Marketing documentation is wrong and we should be able to invoke the below resource just by passing a tag name as a query parameter? Can we conclude saying that the getTagByNameRequest Body parameter is not required at all for this resource?
  
  Based on this, we can do our API implementation and inform the front end team about the exact parameters to be passed.
  
  /rest/asset/v1/tagType/byName.json
  Like • Show 0 Likes0
  Actions
  - Sanford Whiteman @ Evanthika Amarasiri on May 1, 2018 5:33 PM
    Unmark Correct
    Correct Answer
    Yes, I think your assumptions are right on.
    
    Maybe the POST variation was intended to allow some other functionality (like a filter by some other characteristic) but it wasn't implemented. More likely it just isn't supposed to be in the docs.
    Like • Show 0 Likes0
    Actions
    - Evanthika Amarasiri @ Sanford Whiteman on May 1, 2018 5:37 PM
      Mark Correct
      Correct Answer
      Awesome! Many thanks for the prompt responses. I will inform the relevant teams accordingly. Hope the documentation will be corrected in future.
      
      Regards,
      Evanthika
      Like • Show 0 Likes0
      Actions

What are the values to be passed in getTagByNameRequest of 'Get Tag By Name' Resource

Outcomes

Related Content

Recommended Content