If you like this service please feel free to support me in keeping it hosted by a donation:
 
Donate to MSTAGREST

What ?

The MS Tag Rest interface is a third-party (non-Microsoft related) webservice that allows access to the original SOAP exposed service for Microsoft Tag ©. It is a WCF service that has implemented the WCF REST Starterkit Preview 2.

Why ?

I wanted to play around with the API using PHP but I couldn't get the SOAP interface to play nice. I also found several requests for a REST based interface towards the existing API. I also noticed this wasn't very high up on the list of priorities for team behind the Tag technology so I decided to build a REST based WCF service that just proxies requests from the client to the API. It is actually nothing more than a facade that transforms the request to the API and back to the client. Nothing is stored in the service!

How ?

Creating a URI Tag.

Uri template: http://tag.ws.suddenelfilio.net/mstagrest.svc/CreateURITag?at={accessToken}&cn={categoryname}&in={interactionNote}&mfu={medFiUrl}&ts={tagStatus}&t={title}&it={imageType}&ued={utcEndDate}&usd={utcStartDate}
  • at: accessToken = the token that was provided to you by the Microsoft Tag Team. You can apply for a token here: http://tag.microsoft.com/ws/accessrequest.aspx?wa=wsignin1.0
  • cn: categoryName = the name of the category in which the Tag needs to be created. Default category is Main
  • in: interactionNote = the value for the interaction note also known as the Tag Notes section of the Ad Management
  • mfu: medFiUrl = the uri that to which a resolved Tag will be redirected.
  • ts: tagStatus = the status of the Tag when it gets created. Possible values are Active en Paused
  • t: title = the title for the Tag.
  • it: imageType = the type of image into which a Tag is rendered
    • pdf
    • wmf
    • jpeg
    • png
    • gif
    • tiff
  • ued: UTCEndDate = the date in UTC format for which the Tag vailidity ends.
  • usd: UTCStartDate = the date in UTC format for which the Tag vailidity starts.

Deleting a Tag.

Uri template: http://tag.ws.suddenelfilio.net/mstagrest.svc/DeleteTag?at={accessToken}&cn={categoryname}&t={title}
  • at: accessToken = the token that was provided to you by the Microsoft Tag Team. You can apply for a token here: http://tag.microsoft.com/ws/accessrequest.aspx?wa=wsignin1.0
  • cn: categoryName = the name of the category in which the Tag needs to be created. Default category is Main
  • t: title = the title for the Tag.

Editing a URI Tag.

Uri template: http://tag.ws.suddenelfilio.net/mstagrest.svc/EditURITag?at={accessToken}&cn={categoryname}&ct={currentTitle}&in={interactionNote}&mfu={medFiUrl}&ts={tagStatus}&t={title}&it={imageType}&ued={utcEndDate}&usd={utcStartDate}
  • at: accessToken = the token that was provided to you by the Microsoft Tag Team. You can apply for a token here: http://tag.microsoft.com/ws/accessrequest.aspx?wa=wsignin1.0
  • cn: categoryName = the name of the category in which the Tag needs to be created. Default category is Main
  • ct: currentTitle = the title of the existing Tag that will be updated.
  • in: interactionNote = the value for the interaction note also known as the Tag Notes section of the Ad Management
  • mfu: medFiUrl = the uri that to which a resolved Tag will be redirected.
  • ts: tagStatus = the status of the Tag when it gets created. Possible values are Active en Paused
  • t: title = the title for the Tag.
  • it: imageType = the type of image into which a Tag is rendered
    • pdf
    • wmf
    • jpeg
    • png
    • gif
    • tiff
  • ued: UTCEndDate = the date in UTC format for which the Tag vailidity ends.
  • usd: UTCStartDate = the date in UTC format for which the Tag vailidity starts.

Creating a FreeText Tag.

Uri template: http://tag.ws.suddenelfilio.net/mstagrest.svc/CreateFreeTextTag?at={accessToken}&cn={categoryname}&in={interactionNote}&ft={freeText}&p={password}&ts={tagStatus}&t={title}&it={imageType}&ued={utcEndDate}&usd={utcStartDate}
  • at: accessToken = the token that was provided to you by the Microsoft Tag Team. You can apply for a token here: http://tag.microsoft.com/ws/accessrequest.aspx?wa=wsignin1.0
  • cn: categoryName = the name of the category in which the Tag needs to be created. Default category is Main
  • in: interactionNote = the value for the interaction note also known as the Tag Notes section of the Ad Management
  • ft: freeText = the text that will be displayed when the Tag is resolved.
  • p: password = the password that protects the Tag from being viewed after it has been resolved.
  • ts: tagStatus = the status of the Tag when it gets created. Possible values are Active en Paused
  • t: title = the title for the Tag.
  • it: imageType = the type of image into which a Tag is rendered
    • pdf
    • wmf
    • jpeg
    • png
    • gif
    • tiff
  • ued: UTCEndDate = the date in UTC format for which the Tag vailidity ends.
  • usd: UTCStartDate = the date in UTC format for which the Tag vailidity starts.

Editing a FreeText Tag.

Uri template: http://tag.ws.suddenelfilio.net/mstagrest.svc/EditFreeTextTag?at={accessToken}&cn={categoryname}&ct={currentTitle}&in={interactionNote}&ft={freeText}&p={password}&ts={tagStatus}&t={title}&it={imageType}&ued={utcEndDate}&usd={utcStartDate}
  • at: accessToken = the token that was provided to you by the Microsoft Tag Team. You can apply for a token here: http://tag.microsoft.com/ws/accessrequest.aspx?wa=wsignin1.0
  • cn: categoryName = the name of the category in which the Tag needs to be created. Default category is Main
  • ct: currentTitle = the title of the existing Tag that will be updated.
  • in: interactionNote = the value for the interaction note also known as the Tag Notes section of the Ad Management
  • ft: freeText = the text that will be displayed when the Tag is resolved.
  • p: password = the password that protects the Tag from being viewed after it has been resolved.
  • ts: tagStatus = the status of the Tag when it gets created. Possible values are Active en Paused
  • t: title = the title for the Tag.
  • it: imageType = the type of image into which a Tag is rendered
    • pdf
    • wmf
    • jpeg
    • png
    • gif
    • tiff
  • ued: UTCEndDate = the date in UTC format for which the Tag vailidity ends.
  • usd: UTCStartDate = the date in UTC format for which the Tag vailidity starts.

Creating a Dialer Tag.

Uri template: http://tag.ws.suddenelfilio.net/mstagrest.svc/CreateDialerTag?at={accessToken}&cn={categoryname}&in={interactionNote}&pn={phoneNumber}&p={password}&ts={tagStatus}&t={title}&it={imageType}&ued={utcEndDate}&usd={utcStartDate}
  • at: accessToken = the token that was provided to you by the Microsoft Tag Team. You can apply for a token here: http://tag.microsoft.com/ws/accessrequest.aspx?wa=wsignin1.0
  • cn: categoryName = the name of the category in which the Tag needs to be created. Default category is Main
  • in: interactionNote = the value for the interaction note also known as the Tag Notes section of the Ad Management
  • pn: phoneNumber = the phone number that will asked to dial when the Tag is resolved.
  • p: password = the password that protects the Tag from being accessed after it has been resolved.
  • ts: tagStatus = the status of the Tag when it gets created. Possible values are Active en Paused
  • t: title = the title for the Tag.
  • it: imageType = the type of image into which a Tag is rendered
    • pdf
    • wmf
    • jpeg
    • png
    • gif
    • tiff
  • ued: UTCEndDate = the date in UTC format for which the Tag vailidity ends.
  • usd: UTCStartDate = the date in UTC format for which the Tag vailidity starts.

Editing a Dialer Tag.

Uri template: http://tag.ws.suddenelfilio.net/mstagrest.svc/EditDialerTag?at={accessToken}&cn={categoryname}&ct={currentTitle}&in={interactionNote}&pn={phoneNumber}&p={password}&ts={tagStatus}&t={title}&it={imageType}&ued={utcEndDate}&usd={utcStartDate}
  • at: accessToken = the token that was provided to you by the Microsoft Tag Team. You can apply for a token here: http://tag.microsoft.com/ws/accessrequest.aspx?wa=wsignin1.0
  • cn: categoryName = the name of the category in which the Tag needs to be created. Default category is Main
  • ct: currentTitle = the title of the existing Tag that will be updated.
  • in: interactionNote = the value for the interaction note also known as the Tag Notes section of the Ad Management
  • pn: phoneNumber = the phone number that will asked to dial when the Tag is resolved.
  • p: password = the password that protects the Tag from being accessed after it has been resolved.
  • ts: tagStatus = the status of the Tag when it gets created. Possible values are Active en Paused
  • t: title = the title for the Tag.
  • it: imageType = the type of image into which a Tag is rendered
    • pdf
    • wmf
    • jpeg
    • png
    • gif
    • tiff
  • ued: UTCEndDate = the date in UTC format for which the Tag vailidity ends.
  • usd: UTCStartDate = the date in UTC format for which the Tag vailidity starts.

Creating a Vcard Tag.

Uri template: http://tag.ws.suddenelfilio.net/mstagrest.svc/CreateVcardTag?at={accessToken}&cn={categoryname}&in={interactionNote}&p={password}&ts={tagStatus}&t={title}&it={imageType}&ued={utcEndDate}&usd={utcStartDate}&c={city}&co={company}&cou={country}&e={email}&f={fax}&fn={firstname}&ln={lastname}&mp={mobilePhone}&st={state}&w={webpage}&wp={workPhone}&z={zip}&str={street}&dep={department}&jt={jobtitle}&ima={imaddress}
  • at: accessToken = the token that was provided to you by the Microsoft Tag Team. You can apply for a token here: http://tag.microsoft.com/ws/accessrequest.aspx?wa=wsignin1.0
  • cn: categoryName = the name of the category in which the Tag needs to be created. Default category is Main
  • in: interactionNote = the value for the interaction note also known as the Tag Notes section of the Ad Management
  • p: password = the password that protects the Tag from being accessed after it has been resolved.
  • ts: tagStatus = the status of the Tag when it gets created. Possible values are Active en Paused
  • t: title = the title for the Tag.
  • it: imageType = the type of image into which a Tag is rendered
    • pdf
    • wmf
    • jpeg
    • png
    • gif
    • tiff
  • c: city = the value of the city on the vcard.
  • co: company = the value of the company on the vcard.
  • cou: country = the value of the country on the vcard.
  • e: email = the value of the email on the vcard.
  • f: fax = the value of the fax on the vcard.
  • fn: firstname= the value of the firstname on the vcard.
  • ln: lastname = the value of the lastname on the vcard.
  • mp: mobilePhone = the value of the cellphone on the vcard.
  • st: state = the value of the state on the vcard.
  • w: webpage = the value of the webpage on the vcard.
  • wp: workPhone = the value of the work phone on the vcard.
  • z: zip = the value of the zip on the vcard.
  • str: street = the value of the street on the vcard.
  • dep: department = the value of the department on the vcard
  • jt: jobtitle = the value of the jobtitle on the vcard
  • ima: imaddress = the value of the imaddress on the vcard

Editing a Vcard Tag.

Uri template: http://tag.ws.suddenelfilio.net/mstagrest.svc/EditVcardTag?at={accessToken}&cn={categoryname}&ct={currentTitle}&in={interactionNote}&p={password}&ts={tagStatus}&t={title}&it={imageType}&ued={utcEndDate}&usd={utcStartDate}&c={city}&co={company}&cou={country}&e={email}&f={fax}&fn={firstname}&ln={lastname}&mp={mobilePhone}&st={state}&w={webpage}&wp={workPhone}&z={zip}&str={street}&dep={department}&jt={jobtitle}&ima={imaddress}
  • at: accessToken = the token that was provided to you by the Microsoft Tag Team. You can apply for a token here: http://tag.microsoft.com/ws/accessrequest.aspx?wa=wsignin1.0
  • cn: categoryName = the name of the category in which the Tag needs to be created. Default category is Main
  • ct: currentTitle = the title of the existing Tag that will be updated.
  • in: interactionNote = the value for the interaction note also known as the Tag Notes section of the Ad Management
  • p: password = the password that protects the Tag from being accessed after it has been resolved.
  • ts: tagStatus = the status of the Tag when it gets created. Possible values are Active en Paused
  • t: title = the title for the Tag.
  • it: imageType = the type of image into which a Tag is rendered
    • pdf
    • wmf
    • jpeg
    • png
    • gif
    • tiff
  • c: city = the value of the city on the vcard.
  • co: company = the value of the company on the vcard.
  • cou: country = the value of the country on the vcard.
  • e: email = the value of the email on the vcard.
  • f: fax = the value of the fax on the vcard.
  • fn: firstname= the value of the firstname on the vcard.
  • ln: lastname = the value of the lastname on the vcard.
  • mp: mobilePhone = the value of the cellphone on the vcard.
  • st: state = the value of the state on the vcard.
  • w: webpage = the value of the webpage on the vcard.
  • wp: workPhone = the value of the work phone on the vcard.
  • z: zip = the value of the zip on the vcard.
  • str: street = the value of the street on the vcard.
  • dep: department = the value of the department on the vcard
  • jt: jobtitle = the value of the jobtitle on the vcard
  • ima: imaddress = the value of the imaddress on the vcard

Activating a Tag.

Uri template: http://tag.ws.suddenelfilio.net/mstagrest.svc/ActivateTag?at={accessToken}&cn={categoryName}&tt={tagTitle}

Pausing a Tag.

Uri template: http://tag.ws.suddenelfilio.net/mstagrest.svc/PauseTag?at={accessToken}&cn={categoryName}

Generating the barcode.

Uri template: http://tag.ws.suddenelfilio.net/mstagrest.svc/GenerateBarcode?at={accessToken}&cn={categoryname}&tn={tagName}&it={imageType}&s={size}&dt={decorationType}&bw={blackAndWhite}
  • at: accessToken = the token that was provided to you by the Microsoft Tag Team. You can apply for a token here: http://tag.microsoft.com/ws/accessrequest.aspx?wa=wsignin1.0
  • cn: categoryName = the name of the category in which the Tag needs to be created. Default category is Main
  • tn: tagName = the name or title of the Tag that needs to be generated.
  • it: imageType = the type of image into which a Tag is rendered
    • pdf
    • wmf
    • jpeg
    • png
    • gif
    • tiff
  • s: size = the size of the Tag in inches.
  • dt: decorationType = the type of decoration that is added to the Tag on generation.
    • HCCBRP_DECORATION_NONE
    • HCCBRP_DECORATION_DOWNLOAD
    • HCCBENCODEFLAG_STYLIZED
    • HCCBRP_DECORATION_FRAMEPLAIN
  • bw: blackAndWhite = indicates if the tag should be rendered in black and white or in color. Possible values are true and false.

Creating a category.

Uri template: http://tag.ws.suddenelfilio.net/mstagrest.svc/CreateCategory?at={accessToken}&cn={categoryName}&s={status}&usd={utcStartDate}&ued={utcEndDate}
  • at: accessToken = the token that was provided to you by the Microsoft Tag Team. You can apply for a token here: http://tag.microsoft.com/ws/accessrequest.aspx?wa=wsignin1.0
  • cn: categoryName = the name of the category.
  • s: status = the status of the category. Poissible values are Active and Paused.
  • ued: UTCEndDate = the date in UTC format for which the category vailidity ends.
  • usd: UTCStartDate = the date in UTC format for which the category vailidity starts.

Editing a category.

Uri template: http://tag.ws.suddenelfilio.net/mstagrest.svc/EditCategory?at={accessToken}&ocn={originalCategoryName}&ncn={newCategoryName}&s={status}&usd={utcStartDate}&ued={utcEndDate}
  • at: accessToken = the token that was provided to you by the Microsoft Tag Team. You can apply for a token here: http://tag.microsoft.com/ws/accessrequest.aspx?wa=wsignin1.0
  • ocn: originalCategoryName = the current name of the category.
  • ncn: newCategoryName = the new name of the category.
  • s: status = the status of the category. Poissible values are Active and Paused.
  • ued: UTCEndDate = the date in UTC format for which the category vailidity ends.
  • usd: UTCStartDate = the date in UTC format for which the category vailidity starts.

Activating a category.

Uri template: http://tag.ws.suddenelfilio.net/mstagrest.svc/ActivateCategory?at={accessToken}&cn={categoryName}

Pausing a category.

Uri template: http://tag.ws.suddenelfilio.net/mstagrest.svc/PauseCategory?at={accessToken}&cn={categoryName}

Getting a Tag ID.

Uri template: http://tag.ws.suddenelfilio.net/mstagrest.svc/GetTagID?at={accessToken}&cn={categoryName}&tt={title}
  • at: accessToken = the token that was provided to you by the Microsoft Tag Team. You can apply for a token here: http://tag.microsoft.com/ws/accessrequest.aspx?wa=wsignin1.0
  • cn: categoryName = the name of the category that needs to be paused.
  • tt: tagTitle = the title of the Tag that needs to be activated.

Related Projects:

If you are using this service in a project please let me know at and I will put your project on this site as a reference.

Microsoft Tag PHP library

Currently parallel to this project there is a PHP library being created by suddeneflilio that uses this interface to access the Microsoft Tag API. This library will implement this REST service. It is located at Codeplex: http://mstagrestlib.codeplex.com/

Microsoft Tag Java library

Currently parallel to this project there is a Java library being created by suddeneflilio that uses this interface to access the Microsoft Tag API. This library will implement this REST service. It is located at Codeplex: http://mstagjavalib.codeplex.com/

Service Statistics:

Get Microsoft Silverlight
This Service is not in any way affiliated with Microsoft © or the Microsoft Tag © product. It is licensed under the GNU General Public License version 2 (GPLv2) license.